@aws-cdk_aws-batch-alpha.IEcsEc2ContainerDefinition

interface IEcsEc2ContainerDefinition ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.IEcsEc2ContainerDefinition
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#IEcsEc2ContainerDefinition
Javasoftware.amazon.awscdk.services.batch.alpha.IEcsEc2ContainerDefinition
Pythonaws_cdk.aws_batch_alpha.IEcsEc2ContainerDefinition
TypeScript (source)@aws-cdk/aws-batch-alpha ยป IEcsEc2ContainerDefinition

Implemented by EcsEc2ContainerDefinition

A container orchestrated by ECS that uses EC2 resources.

Properties

NameTypeDescription
cpu๐Ÿ”นnumberThe number of vCPUs reserved for the container.
executionRole๐Ÿ”นIRoleThe role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.
image๐Ÿ”นContainerImageThe image that this container will run.
memory๐Ÿ”นSizeThe memory hard limit present to the container.
node๐Ÿ”นNodeThe tree node.
ulimits๐Ÿ”นUlimit[]Limits to set for the user this docker container will run as.
volumes๐Ÿ”นEcsVolume[]The volumes to mount to this container.
command?๐Ÿ”นstring[]The command that's passed to the container.
environment?๐Ÿ”น{ [string]: string }The environment variables to pass to a container.
gpu?๐Ÿ”นnumberThe number of physical GPUs to reserve for the container.
jobRole?๐Ÿ”นIRoleThe role that the container can assume.
linuxParameters?๐Ÿ”นLinuxParametersLinux-specific modifications that are applied to the container, such as details for device mappings.
logDriverConfig?๐Ÿ”นLogDriverConfigThe configuration of the log driver.
privileged?๐Ÿ”นbooleanWhen this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user).
readonlyRootFilesystem?๐Ÿ”นbooleanGives the container readonly access to its root filesystem.
secrets?๐Ÿ”น{ [string]: ISecret }A map from environment variable names to the secrets for the container.
user?๐Ÿ”นstringThe user name to use inside the container.

cpu๐Ÿ”น

Type: number

The number of vCPUs reserved for the container.

Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.


executionRole๐Ÿ”น

Type: IRole

The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.

See also: https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html


image๐Ÿ”น

Type: ContainerImage

The image that this container will run.


memory๐Ÿ”น

Type: Size

The memory hard limit present to the container.

If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.


node๐Ÿ”น

Type: Node

The tree node.


ulimits๐Ÿ”น

Type: Ulimit[]

Limits to set for the user this docker container will run as.


volumes๐Ÿ”น

Type: EcsVolume[]

The volumes to mount to this container.

Automatically added to the job definition.


command?๐Ÿ”น

Type: string[] (optional)

The command that's passed to the container.

See also: https://docs.docker.com/engine/reference/builder/#cmd


environment?๐Ÿ”น

Type: { [string]: string } (optional, default: no environment variables)

The environment variables to pass to a container.

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


gpu?๐Ÿ”น

Type: number (optional, default: no gpus)

The number of physical GPUs to reserve for the container.

Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.


jobRole?๐Ÿ”น

Type: IRole (optional, default: no jobRole)

The role that the container can assume.

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html


linuxParameters?๐Ÿ”น

Type: LinuxParameters (optional, default: none)

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


logDriverConfig?๐Ÿ”น

Type: LogDriverConfig (optional)

The configuration of the log driver.


privileged?๐Ÿ”น

Type: boolean (optional, default: false)

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


readonlyRootFilesystem?๐Ÿ”น

Type: boolean (optional, default: false)

Gives the container readonly access to its root filesystem.


secrets?๐Ÿ”น

Type: { [string]: ISecret } (optional, default: no secrets)

A map from environment variable names to the secrets for the container.

Allows your job definitions to reference the secret by the environment variable name defined in this property.

See also: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html


user?๐Ÿ”น

Type: string (optional, default: no user)

The user name to use inside the container.

Methods

NameDescription
addUlimit(ulimit)๐Ÿ”นAdd a ulimit to this container.
addVolume(volume)๐Ÿ”นAdd a Volume to this container.

addUlimit(ulimit)๐Ÿ”น

public addUlimit(ulimit: Ulimit): void

Parameters

  • ulimit Ulimit

Add a ulimit to this container.


addVolume(volume)๐Ÿ”น

public addVolume(volume: EcsVolume): void

Parameters

  • volume EcsVolume

Add a Volume to this container.