Package software.amazon.awscdk.services.batch

Class EcsFargateContainerDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.batch.EcsFargateContainerDefinition

All Implemented Interfaces:

IEcsContainerDefinition, IEcsFargateContainerDefinition, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-05T20:26:27.632Z")
@Stability(Stable)
public class EcsFargateContainerDefinition
extends software.constructs.Construct
implements IEcsFargateContainerDefinition, IEcsContainerDefinition

A container orchestrated by ECS that uses Fargate resources.

Example:

 EcsJobDefinition jobDefn = EcsJobDefinition.Builder.create(this, "JobDefn")
         .container(EcsFargateContainerDefinition.Builder.create(this, "myFargateContainer")
                 .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)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EcsFargateContainerDefinition.Builder	A fluent builder for EcsFargateContainerDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IEcsContainerDefinition

IEcsContainerDefinition.Jsii$Default, IEcsContainerDefinition.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IEcsFargateContainerDefinition

IEcsFargateContainerDefinition.Jsii$Default, IEcsFargateContainerDefinition.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EcsFargateContainerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EcsFargateContainerDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	EcsFargateContainerDefinition(software.constructs.Construct scope, String id, EcsFargateContainerDefinitionProps props)

Method Summary

Modifier and Type	Method	Description
void	addVolume(EcsVolume volume)	Add a Volume to this container.
Boolean	getAssignPublicIp()	Indicates whether the job has a public IP address.
List<String>	getCommand()	The command that's passed to the container.
Number	getCpu()	The number of vCPUs reserved for the container.
Map<String,String>	getEnvironment()	The environment variables to pass to a container.
Size	getEphemeralStorageSize()	The size for ephemeral storage.
IRole	getExecutionRole()	The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.
CpuArchitecture	getFargateCpuArchitecture()	The vCPU architecture of Fargate Runtime.
OperatingSystemFamily	getFargateOperatingSystemFamily()	The operating system for the compute environment.
FargatePlatformVersion	getFargatePlatformVersion()	Which version of Fargate to use when running this container.
ContainerImage	getImage()	The image that this container will run.
IRole	getJobRole()	The role that the container can assume.
LinuxParameters	getLinuxParameters()	Linux-specific modifications that are applied to the container, such as details for device mappings.
LogDriverConfig	getLogDriverConfig()	The configuration of the log driver.
Size	getMemory()	The memory hard limit present to the container.
Boolean	getReadonlyRootFilesystem()	Gives the container readonly access to its root filesystem.
Map<String,Secret>	getSecrets()	A map from environment variable names to the secrets for the container.
String	getUser()	The user name to use inside the container.
List<EcsVolume>	getVolumes()	The volumes to mount to this container.

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

EcsFargateContainerDefinition

protected EcsFargateContainerDefinition(software.amazon.jsii.JsiiObjectRef objRef)

EcsFargateContainerDefinition

protected EcsFargateContainerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EcsFargateContainerDefinition

@Stability(Stable)
public EcsFargateContainerDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 EcsFargateContainerDefinitionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

addVolume

@Stability(Stable)
public void addVolume(@NotNull
 EcsVolume volume)

Add a Volume to this container.

Specified by:

addVolume in interface IEcsContainerDefinition

Parameters:

volume - This parameter is required.

getCpu

@Stability(Stable)
@NotNull
public Number getCpu()

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.

Specified by:

getCpu in interface IEcsContainerDefinition

getExecutionRole

@Stability(Stable)
@NotNull
public IRole getExecutionRole()

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

Specified by:

getExecutionRole in interface IEcsContainerDefinition

See Also:

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

getImage

@Stability(Stable)
@NotNull
public ContainerImage getImage()

The image that this container will run.

Specified by:

getImage in interface IEcsContainerDefinition

getMemory

@Stability(Stable)
@NotNull
public Size getMemory()

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.

Specified by:

getMemory in interface IEcsContainerDefinition

getVolumes

@Stability(Stable)
@NotNull
public List<EcsVolume> getVolumes()

The volumes to mount to this container.

Automatically added to the job definition.

Specified by:

getVolumes in interface IEcsContainerDefinition

getAssignPublicIp

@Stability(Stable)
@Nullable
public Boolean getAssignPublicIp()

Indicates whether the job has a public IP address.

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.

Specified by:

getAssignPublicIp in interface IEcsFargateContainerDefinition

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html

getCommand

@Stability(Stable)
@Nullable
public List<String> getCommand()

The command that's passed to the container.

Specified by:

getCommand in interface IEcsContainerDefinition

See Also:

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

getEnvironment

@Stability(Stable)
@Nullable
public Map<String,String> getEnvironment()

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.

Specified by:

getEnvironment in interface IEcsContainerDefinition

getEphemeralStorageSize

@Stability(Stable)
@Nullable
public Size getEphemeralStorageSize()

The size for ephemeral storage.

Specified by:

getEphemeralStorageSize in interface IEcsFargateContainerDefinition

getFargateCpuArchitecture

@Stability(Stable)
@Nullable
public CpuArchitecture getFargateCpuArchitecture()

The vCPU architecture of Fargate Runtime.

Specified by:

getFargateCpuArchitecture in interface IEcsFargateContainerDefinition

getFargateOperatingSystemFamily

@Stability(Stable)
@Nullable
public OperatingSystemFamily getFargateOperatingSystemFamily()

The operating system for the compute environment.

Specified by:

getFargateOperatingSystemFamily in interface IEcsFargateContainerDefinition

getFargatePlatformVersion

@Stability(Stable)
@Nullable
public FargatePlatformVersion getFargatePlatformVersion()

Which version of Fargate to use when running this container.

Specified by:

getFargatePlatformVersion in interface IEcsFargateContainerDefinition

getJobRole

@Stability(Stable)
@Nullable
public IRole getJobRole()

The role that the container can assume.

Specified by:

getJobRole in interface IEcsContainerDefinition

See Also:

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

getLinuxParameters

@Stability(Stable)
@Nullable
public LinuxParameters getLinuxParameters()

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

Specified by:

getLinuxParameters in interface IEcsContainerDefinition

getLogDriverConfig

@Stability(Stable)
@Nullable
public LogDriverConfig getLogDriverConfig()

The configuration of the log driver.

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition

getReadonlyRootFilesystem

@Stability(Stable)
@Nullable
public Boolean getReadonlyRootFilesystem()

Gives the container readonly access to its root filesystem.

Specified by:

getReadonlyRootFilesystem in interface IEcsContainerDefinition

getSecrets

@Stability(Stable)
@Nullable
public Map<String,Secret> getSecrets()

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.

Specified by:

getSecrets in interface IEcsContainerDefinition

See Also:

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

getUser

@Stability(Stable)
@Nullable
public String getUser()

The user name to use inside the container.

Specified by:

getUser in interface IEcsContainerDefinition