AWS SDK Version 3 for .NET
API Reference

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.

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

Inheritance Hierarchy

System.Object
  Amazon.Batch.Model.ContainerProperties

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

C#
public class ContainerProperties

The ContainerProperties type exposes the following members

Constructors

NameDescription
Public Method ContainerProperties()

Properties

NameTypeDescription
Public Property Command System.Collections.Generic.List<System.String>

Gets and sets the property Command.

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.

Public Property Environment System.Collections.Generic.List<Amazon.Batch.Model.KeyValuePair>

Gets and sets the property Environment.

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 plain text environment variables for sensitive information, such as credential data.

Public Property Image System.String

Gets and sets the property 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 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..amazonaws.com/).

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

Public Property JobRoleArn System.String

Gets and sets the property JobRoleArn.

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

Public Property Memory System.Int32

Gets and sets the property Memory.

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.

Public Property MountPoints System.Collections.Generic.List<Amazon.Batch.Model.MountPoint>

Gets and sets the property MountPoints.

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.

Public Property Privileged System.Boolean

Gets and sets the property Privileged.

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.

Public Property 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 ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

Public Property Ulimits System.Collections.Generic.List<Amazon.Batch.Model.Ulimit>

Gets and sets the property Ulimits.

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.

Public Property User System.String

Gets and sets the property User.

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.

Public Property Vcpus System.Int32

Gets and sets the property Vcpus.

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 1 vCPU.

Public Property Volumes System.Collections.Generic.List<Amazon.Batch.Model.Volume>

Gets and sets the property Volumes.

A list of data volumes used in a job.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms