AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
An object that represents the details of a container that's part of a job.
Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z
public class ContainerDetail
The ContainerDetail type exposes the following members
Name | Description | |
---|---|---|
ContainerDetail() |
Name | Type | Description | |
---|---|---|---|
Command | System.Collections.Generic.List<System.String> |
Gets and sets the property Command. The command that's passed to the container. |
|
ContainerInstanceArn | System.String |
Gets and sets the property ContainerInstanceArn. The Amazon Resource Name (ARN) of the container instance that the container is running on. |
|
Environment | System.Collections.Generic.List<Amazon.Batch.Model.KeyValuePair> |
Gets and sets the property Environment. The environment variables to pass to a container.
Environment variables cannot start with " |
|
EphemeralStorage | Amazon.Batch.Model.EphemeralStorage |
Gets and sets the property EphemeralStorage. The amount of ephemeral storage allocated for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. |
|
ExecutionRoleArn | System.String |
Gets and sets the property ExecutionRoleArn. The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide. |
|
ExitCode | System.Int32 |
Gets and sets the property ExitCode. The exit code returned upon completion. |
|
FargatePlatformConfiguration | Amazon.Batch.Model.FargatePlatformConfiguration |
Gets and sets the property FargatePlatformConfiguration. The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter. |
|
Image | System.String |
Gets and sets the property Image. The image used to start the container. |
|
InstanceType | System.String |
Gets and sets the property InstanceType. The instance type of the underlying host infrastructure of a multi-node parallel job. This parameter isn't applicable to jobs that are running on Fargate resources. |
|
JobRoleArn | System.String |
Gets and sets the property JobRoleArn. The Amazon Resource Name (ARN) that's associated with the job when run. |
|
LinuxParameters | Amazon.Batch.Model.LinuxParameters |
Gets and sets the property LinuxParameters. Linux-specific modifications that are applied to the container, such as details for device mappings. |
|
LogConfiguration | Amazon.Batch.Model.LogConfiguration |
Gets and sets the property LogConfiguration. The log configuration specification for the container.
This parameter maps to Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.
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 in
to your container instance and run the following command:
The Amazon ECS container agent running on a container instance must register the logging
drivers available on that instance with the |
|
LogStreamName | System.String |
Gets and sets the property LogStreamName.
The name of the Amazon CloudWatch Logs log stream that's associated with the container.
The log group for Batch jobs is |
|
Memory | System.Int32 |
Gets and sets the property Memory.
For jobs running on Amazon EC2 resources that didn't specify memory requirements using
|
|
MountPoints | System.Collections.Generic.List<Amazon.Batch.Model.MountPoint> |
Gets and sets the property MountPoints. The mount points for data volumes in your container. |
|
NetworkConfiguration | Amazon.Batch.Model.NetworkConfiguration |
Gets and sets the property NetworkConfiguration. The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter. |
|
NetworkInterfaces | System.Collections.Generic.List<Amazon.Batch.Model.NetworkInterface> |
Gets and sets the property NetworkInterfaces. The network interfaces that are associated with the job. |
|
Privileged | System.Boolean |
Gets and sets the property Privileged.
When this parameter is true, the container is given elevated permissions on the host
container instance (similar to the
This parameter isn't applicable to jobs that are running on Fargate resources and
shouldn't be provided, or specified as |
|
ReadonlyRootFilesystem | System.Boolean |
Gets and sets the property ReadonlyRootFilesystem.
When this parameter is true, the container is given read-only access to its root file
system. This parameter maps to |
|
Reason | System.String |
Gets and sets the property Reason. A short (255 max characters) human-readable string to provide additional details for a running or stopped container. |
|
RepositoryCredentials | Amazon.Batch.Model.RepositoryCredentials |
Gets and sets the property RepositoryCredentials. The private repository authentication credentials to use. |
|
ResourceRequirements | System.Collections.Generic.List<Amazon.Batch.Model.ResourceRequirement> |
Gets and sets the property ResourceRequirements.
The type and amount of resources to assign to a container. The supported resources
include |
|
RuntimePlatform | Amazon.Batch.Model.RuntimePlatform |
Gets and sets the property RuntimePlatform. An object that represents the compute environment architecture for Batch jobs on Fargate. |
|
Secrets | System.Collections.Generic.List<Amazon.Batch.Model.Secret> |
Gets and sets the property Secrets. The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide. |
|
TaskArn | System.String |
Gets and sets the property TaskArn.
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 |
|
Ulimits | System.Collections.Generic.List<Amazon.Batch.Model.Ulimit> |
Gets and sets the property Ulimits.
A list of This parameter isn't applicable to jobs that are running on Fargate resources. |
|
User | System.String |
Gets and sets the property User.
The user name to use inside the container. This parameter maps to |
|
Vcpus | System.Int32 |
Gets and sets the property Vcpus.
The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources,
you can specify the vCPU requirement for the job using
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that
run on Fargate resources, you must specify the vCPU requirement for the job using
|
|
Volumes | System.Collections.Generic.List<Amazon.Batch.Model.Volume> |
Gets and sets the property Volumes. A list of volumes that are associated with the job. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5