ContainerDetail class

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

Constructors

ContainerDetail({List<String>? command, String? containerInstanceArn, List<KeyValuePair>? environment, String? executionRoleArn, int? exitCode, FargatePlatformConfiguration? fargatePlatformConfiguration, String? image, String? instanceType, String? jobRoleArn, LinuxParameters? linuxParameters, LogConfiguration? logConfiguration, String? logStreamName, int? memory, List<MountPoint>? mountPoints, NetworkConfiguration? networkConfiguration, List<NetworkInterface>? networkInterfaces, bool? privileged, bool? readonlyRootFilesystem, String? reason, List<ResourceRequirement>? resourceRequirements, List<Secret>? secrets, String? taskArn, List<Ulimit>? ulimits, String? user, int? vcpus, List<Volume>? volumes})

ContainerDetail.fromJson(Map<String, dynamic> json)

factory

Properties

command → List<String>?

The command that's passed to the container.

final

containerInstanceArn → String?

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

final

environment → List<KeyValuePair>?

The environment variables to pass to a container.

final

executionRoleArn → String?

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.

final

exitCode → int?

The exit code to return upon completion.

final

fargatePlatformConfiguration → FargatePlatformConfiguration?

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

final

hashCode → int

The hash code for this object.

no setter, inherited

image → String?

The image used to start the container.

final

instanceType → String?

The instance type of the underlying host infrastructure of a multi-node parallel job.

final

jobRoleArn → String?

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

final

linuxParameters → LinuxParameters?

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

final

logConfiguration → LogConfiguration?

The log configuration specification for the container.

final

logStreamName → String?

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.

final

memory → int?

For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

final

mountPoints → List<MountPoint>?

The mount points for data volumes in your container.

final

networkConfiguration → NetworkConfiguration?

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

final

networkInterfaces → List<NetworkInterface>?

The network interfaces associated with the job.

final

privileged → bool?

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.

final

readonlyRootFilesystem → bool?

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 .

final

reason → String?

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

final

resourceRequirements → List<ResourceRequirement>?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secrets → List<Secret>?

The secrets to pass to the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.

final

taskArn → String?

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

final

ulimits → List<Ulimit>?

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

final

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.

final

vcpus → int?

The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement object. 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. It must be specified for each node at least once.

final

volumes → List<Volume>?

A list of volumes associated with the job.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited