Class EcsEc2ContainerDefinition
A container orchestrated by ECS that uses EC2 resources.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EcsEc2ContainerDefinition : Construct, IEcsEc2ContainerDefinition, IEcsContainerDefinition
Syntax (vb)
Public Class EcsEc2ContainerDefinition
Inherits Construct
Implements IEcsEc2ContainerDefinition, IEcsContainerDefinition
Remarks
ExampleMetadata: infused
Examples
IVpc vpc;
var ecsJob = new EcsJobDefinition(this, "JobDefn", new EcsJobDefinitionProps {
Container = new EcsEc2ContainerDefinition(this, "containerDefn", new EcsEc2ContainerDefinitionProps {
Image = ContainerImage.FromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
Memory = Size.Mebibytes(2048),
Cpu = 256
})
});
var queue = new JobQueue(this, "JobQueue", new JobQueueProps {
ComputeEnvironments = new [] { new OrderedComputeEnvironment {
ComputeEnvironment = new ManagedEc2EcsComputeEnvironment(this, "managedEc2CE", new ManagedEc2EcsComputeEnvironmentProps {
Vpc = vpc
}),
Order = 1
} },
Priority = 10
});
var user = new User(this, "MyUser");
ecsJob.GrantSubmitJob(user, queue);
Synopsis
Constructors
EcsEc2ContainerDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
EcsEc2ContainerDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
EcsEc2ContainerDefinition(Construct, String, IEcsEc2ContainerDefinitionProps) |
Properties
Command | The command that's passed to the container. |
Cpu | The number of vCPUs reserved for the container. |
Environment | The environment variables to pass to a container. |
ExecutionRole | The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf. |
Gpu | The number of physical GPUs to reserve for the container. |
Image | The image that this container will run. |
JobRole | The role that the container can assume. |
LinuxParameters | Linux-specific modifications that are applied to the container, such as details for device mappings. |
LogDriverConfig | The configuration of the log driver. |
Memory | The memory hard limit present to the container. |
Privileged | When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). |
ReadonlyRootFilesystem | Gives the container readonly access to its root filesystem. |
Secrets | A map from environment variable names to the secrets for the container. |
Ulimits | Limits to set for the user this docker container will run as. |
User | The user name to use inside the container. |
Volumes | The volumes to mount to this container. |
Methods
AddUlimit(IUlimit) | Add a ulimit to this container. |
AddVolume(EcsVolume) | Add a Volume to this container. |
Constructors
EcsEc2ContainerDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected EcsEc2ContainerDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
EcsEc2ContainerDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected EcsEc2ContainerDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
EcsEc2ContainerDefinition(Construct, String, IEcsEc2ContainerDefinitionProps)
public EcsEc2ContainerDefinition(Construct scope, string id, IEcsEc2ContainerDefinitionProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IEcsEc2ContainerDefinitionProps
Properties
Command
The command that's passed to the container.
public virtual string[] Command { get; }
Property Value
System.String[]
Cpu
The number of vCPUs reserved for the container.
public virtual double Cpu { get; }
Property Value
System.Double
Remarks
Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.
Environment
The environment variables to pass to a container.
public virtual IDictionary<string, string> Environment { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Cannot start with AWS_BATCH
.
We don't recommend using plaintext environment variables for sensitive information, such as credential data.
ExecutionRole
The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.
public virtual IRole ExecutionRole { get; }
Property Value
Gpu
The number of physical GPUs to reserve for the container.
public virtual Nullable<double> Gpu { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Image
The image that this container will run.
public virtual ContainerImage Image { get; }
Property Value
JobRole
LinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
public virtual LinuxParameters LinuxParameters { get; }
Property Value
LogDriverConfig
The configuration of the log driver.
public virtual ILogDriverConfig LogDriverConfig { get; }
Property Value
Memory
The memory hard limit present to the container.
public virtual Size Memory { get; }
Property Value
Remarks
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.
Privileged
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user).
public virtual Nullable<bool> Privileged { get; }
Property Value
System.Nullable<System.Boolean>
ReadonlyRootFilesystem
Gives the container readonly access to its root filesystem.
public virtual Nullable<bool> ReadonlyRootFilesystem { get; }
Property Value
System.Nullable<System.Boolean>
Secrets
A map from environment variable names to the secrets for the container.
public virtual IDictionary<string, Secret> Secrets { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, Secret>
Remarks
Allows your job definitions to reference the secret by the environment variable name defined in this property.
Ulimits
Limits to set for the user this docker container will run as.
public virtual IUlimit[] Ulimits { get; }
Property Value
IUlimit[]
User
The user name to use inside the container.
public virtual string User { get; }
Property Value
System.String
Volumes
The volumes to mount to this container.
public virtual EcsVolume[] Volumes { get; }
Property Value
Remarks
Automatically added to the job definition.
Methods
AddUlimit(IUlimit)
Add a ulimit to this container.
public virtual void AddUlimit(IUlimit ulimit)
Parameters
- ulimit IUlimit
AddVolume(EcsVolume)
Add a Volume to this container.
public virtual void AddVolume(EcsVolume volume)
Parameters
- volume EcsVolume