@aws-cdk_aws-batch-alpha.IEcsContainerDefinition

interface IEcsContainerDefinition ๐Ÿ”น

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

Implemented by EcsEc2ContainerDefinition, EcsFargateContainerDefinition

A container that can be run with ECS orchestration.

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


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.


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.


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
addVolume(volume)๐Ÿ”นAdd a Volume to this container.

addVolume(volume)๐Ÿ”น

public addVolume(volume: EcsVolume): void

Parameters

  • volume EcsVolume

Add a Volume to this container.