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

Class: Aws::Batch::Types::ContainerDetail

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

Overview

An object representing the details of a container that is part of a job.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

The command that is passed to the container.

Returns:

  • (Array<String>)

    The command that is passed to the container.

#container_instance_arnString

The Amazon Resource Name (ARN) of the container instance on which the container is running.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the container instance on which the container is running.

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

Returns:

#exit_codeInteger

The exit code to return upon completion.

Returns:

  • (Integer)

    The exit code to return upon completion.

#imageString

The image used to start the container.

Returns:

  • (String)

    The image used to start the container.

#job_role_arnString

The Amazon Resource Name (ARN) associated with the job upon execution.

Returns:

  • (String)

    The Amazon Resource Name (ARN) associated with the job upon execution.

#log_stream_nameString

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.

Returns:

  • (String)

    The name of the CloudWatch Logs log stream associated with the container.

#memoryInteger

The number of MiB of memory reserved for the job.

Returns:

  • (Integer)

    The number of MiB of memory reserved for the job.

#mount_pointsArray<Types::MountPoint>

The mount points for data volumes in your container.

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

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.

Returns:

  • (Boolean)

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

#reasonString

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

Returns:

  • (String)

    A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

#task_arnString

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.

#ulimitsArray<Types::Ulimit>

A list of ulimit values to set in the container.

Returns:

  • (Array<Types::Ulimit>)

    A list of ulimit values to set in the container.

#userString

The user name to use inside the container.

Returns:

  • (String)

    The user name to use inside the container.

#vcpusInteger

The number of VCPUs allocated for the job.

Returns:

  • (Integer)

    The number of VCPUs allocated for the job.

#volumesArray<Types::Volume>

A list of volumes associated with the job.

Returns:

  • (Array<Types::Volume>)

    A list of volumes associated with the job.