Class EcsFargateContainerDefinitionProps
Props to configure an EcsFargateContainerDefinition.
Inheritance
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EcsFargateContainerDefinitionProps : Object, IEcsFargateContainerDefinitionProps, IEcsContainerDefinitionProps
Syntax (vb)
Public Class EcsFargateContainerDefinitionProps
Inherits Object
Implements IEcsFargateContainerDefinitionProps, IEcsContainerDefinitionProps
Remarks
ExampleMetadata: infused
Examples
var jobDefn = new EcsJobDefinition(this, "JobDefn", new EcsJobDefinitionProps {
Container = new EcsFargateContainerDefinition(this, "myFargateContainer", new EcsFargateContainerDefinitionProps {
Image = ContainerImage.FromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
Memory = Size.Mebibytes(2048),
Cpu = 256,
EphemeralStorageSize = Size.Gibibytes(100),
FargateCpuArchitecture = CpuArchitecture.ARM64,
FargateOperatingSystemFamily = OperatingSystemFamily.LINUX
})
});
Synopsis
Constructors
EcsFargateContainerDefinitionProps() |
Properties
AssignPublicIp | Indicates whether the job has a public IP address. |
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. |
EphemeralStorageSize | The size for ephemeral storage. |
ExecutionRole | The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf. |
FargateCpuArchitecture | The vCPU architecture of Fargate Runtime. |
FargateOperatingSystemFamily | The operating system for the compute environment. |
FargatePlatformVersion | Which version of Fargate to use when running this 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. |
Logging | The loging configuration for this Job. |
Memory | The memory hard limit present to the container. |
ReadonlyRootFilesystem | Gives the container readonly access to its root filesystem. |
Secrets | A map from environment variable names to the secrets for the container. |
User | The user name to use inside the container. |
Volumes | The volumes to mount to this container. |
Constructors
EcsFargateContainerDefinitionProps()
public EcsFargateContainerDefinitionProps()
Properties
AssignPublicIp
Indicates whether the job has a public IP address.
public Nullable<bool> AssignPublicIp { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet.
Default: false
See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
Command
The command that's passed to the container.
public string[] Command { get; set; }
Property Value
System.String[]
Remarks
Default: - no command
Cpu
The number of vCPUs reserved for the container.
public double Cpu { get; set; }
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 IDictionary<string, string> Environment { get; set; }
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.
Default: - no environment variables
EphemeralStorageSize
The size for ephemeral storage.
public Size EphemeralStorageSize { get; set; }
Property Value
Remarks
Default: - 20 GiB
ExecutionRole
The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.
public IRole ExecutionRole { get; set; }
Property Value
Remarks
Default: - a Role will be created
See: https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html
FargateCpuArchitecture
The vCPU architecture of Fargate Runtime.
public CpuArchitecture FargateCpuArchitecture { get; set; }
Property Value
Remarks
Default: - X86_64
FargateOperatingSystemFamily
The operating system for the compute environment.
public OperatingSystemFamily FargateOperatingSystemFamily { get; set; }
Property Value
Remarks
Default: - LINUX
FargatePlatformVersion
Which version of Fargate to use when running this container.
public Nullable<FargatePlatformVersion> FargatePlatformVersion { get; set; }
Property Value
System.Nullable<FargatePlatformVersion>
Remarks
Default: LATEST
Image
The image that this container will run.
public ContainerImage Image { get; set; }
Property Value
JobRole
The role that the container can assume.
public IRole JobRole { get; set; }
Property Value
Remarks
Default: - no job role
See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
LinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
public LinuxParameters LinuxParameters { get; set; }
Property Value
Remarks
Default: none
Logging
The loging configuration for this Job.
public LogDriver Logging { get; set; }
Property Value
Remarks
Default: - the log configuration of the Docker daemon
Memory
The memory hard limit present to the container.
public Size Memory { get; set; }
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.
ReadonlyRootFilesystem
Gives the container readonly access to its root filesystem.
public Nullable<bool> ReadonlyRootFilesystem { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Secrets
A map from environment variable names to the secrets for the container.
public IDictionary<string, Secret> Secrets { get; set; }
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.
Default: - no secrets
See: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html
User
The user name to use inside the container.
public string User { get; set; }
Property Value
System.String
Remarks
Default: - no user
Volumes
The volumes to mount to this container.
public EcsVolume[] Volumes { get; set; }
Property Value
Remarks
Automatically added to the job definition.
Default: - no volumes