class Aws::Batch::Types::ContainerProperties

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

@note When making an API call, you may pass ContainerProperties

data as a hash:

    {
      image: "String",
      vcpus: 1,
      memory: 1,
      command: ["String"],
      job_role_arn: "String",
      execution_role_arn: "String",
      volumes: [
        {
          host: {
            source_path: "String",
          },
          name: "String",
          efs_volume_configuration: {
            file_system_id: "String", # required
            root_directory: "String",
            transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
            transit_encryption_port: 1,
            authorization_config: {
              access_point_id: "String",
              iam: "ENABLED", # accepts ENABLED, DISABLED
            },
          },
        },
      ],
      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, VCPU, MEMORY
        },
      ],
      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
        },
      ],
      network_configuration: {
        assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
      },
      fargate_platform_configuration: {
        platform_version: "String",
      },
    }

@!attribute [rw] image

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][1] section of the [Docker Remote
API][2] and the `IMAGE` parameter of [docker run][3].

<note markdown="1"> 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.

 </note>

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

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
@return [String]

@!attribute [rw] vcpus

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][1] section of the [Docker Remote API][2] and the
`--cpu-shares` option to [docker run][3]. The number of vCPUs must
be specified but can 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.

<note markdown="1"> This parameter isn't applicable to jobs that are 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`.

 </note>

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
@return [Integer]

@!attribute [rw] memory

This parameter indicates the memory hard limit (in MiB) for a
container. If your container attempts to exceed the specified
number, it's 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][1]
section of the [Docker Remote API][2] and the `--memory` option to
[docker run][3].

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 also do this
for EC2 resources.

<note markdown="1"> 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][4] in the *Batch User Guide*.

 </note>

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
[4]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html
@return [Integer]

@!attribute [rw] command

The command that's passed to the container. This parameter maps to
`Cmd` in the [Create a container][1] section of the [Docker Remote
API][2] and the `COMMAND` parameter to [docker run][3]. For more
information, see
[https://docs.docker.com/engine/reference/builder/#cmd][4].

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
[4]: https://docs.docker.com/engine/reference/builder/#cmd
@return [Array<String>]

@!attribute [rw] job_role_arn

The Amazon Resource Name (ARN) of the IAM role that the container
can assume for Amazon Web Services permissions. For more
information, see [IAM Roles for Tasks][1] in the *Amazon Elastic
Container Service Developer Guide*.

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
@return [String]

@!attribute [rw] execution_role_arn

The Amazon Resource Name (ARN) of the execution role that Batch can
assume. For jobs that run on Fargate resources, you must provide an
execution role. For more information, see [Batch execution IAM
role][1] in the *Batch User Guide*.

[1]: https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html
@return [String]

@!attribute [rw] volumes

A list of data volumes used in a job.
@return [Array<Types::Volume>]

@!attribute [rw] environment

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

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

<note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
convention is reserved for variables that are set by the Batch
service.

 </note>

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
@return [Array<Types::KeyValuePair>]

@!attribute [rw] mount_points

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

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
@return [Array<Types::MountPoint>]

@!attribute [rw] readonly_root_filesystem

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][1] section of the [Docker Remote API][2]
and the `--read-only` option to `docker run`.

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
@return [Boolean]

@!attribute [rw] privileged

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][1] section of the [Docker Remote API][2] and the
`--privileged` option to [docker run][3]. The default value is
false.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources and shouldn't be provided, or specified as false.

 </note>

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
@return [Boolean]

@!attribute [rw] ulimits

A list of `ulimits` to set in the container. This parameter maps to
`Ulimits` in the [Create a container][1] section of the [Docker
Remote API][2] and the `--ulimit` option to [docker run][3].

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources and shouldn't be provided.

 </note>

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
@return [Array<Types::Ulimit>]

@!attribute [rw] user

The user name to use inside the container. This parameter maps to
`User` in the [Create a container][1] section of the [Docker Remote
API][2] and the `--user` option to [docker run][3].

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
@return [String]

@!attribute [rw] instance_type

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.

<note markdown="1"> This parameter isn't applicable to single-node container jobs or
jobs that run on Fargate resources, and shouldn't be provided.

 </note>
@return [String]

@!attribute [rw] resource_requirements

The type and amount of resources to assign to a container. The
supported resources include `GPU`, `MEMORY`, and `VCPU`.
@return [Array<Types::ResourceRequirement>]

@!attribute [rw] linux_parameters

Linux-specific modifications that are applied to the container, such
as details for device mappings.
@return [Types::LinuxParameters]

@!attribute [rw] log_configuration

The log configuration specification for the container.

This parameter maps to `LogConfig` in the [Create a container][1]
section of the [Docker Remote API][2] and the `--log-driver` option
to [docker run][3]. 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][4] in the Docker documentation.

<note markdown="1"> Batch currently supports a subset of the logging drivers available
to the Docker daemon (shown in the LogConfiguration data type).

 </note>

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

<note markdown="1"> 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][5] in the *Amazon Elastic Container Service Developer
Guide*.

 </note>

[1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
[2]: https://docs.docker.com/engine/api/v1.23/
[3]: https://docs.docker.com/engine/reference/run/
[4]: https://docs.docker.com/engine/admin/logging/overview/
[5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
@return [Types::LogConfiguration]

@!attribute [rw] secrets

The secrets for the container. For more information, see [Specifying
sensitive data][1] in the *Batch User Guide*.

[1]: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html
@return [Array<Types::Secret>]

@!attribute [rw] network_configuration

The network configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify
this parameter.
@return [Types::NetworkConfiguration]

@!attribute [rw] fargate_platform_configuration

The platform configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify
this parameter.
@return [Types::FargatePlatformConfiguration]

@see docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerProperties AWS API Documentation

Constants

SENSITIVE