Package software.amazon.awscdk.services.batch

Interface EcsFargateContainerDefinitionProps

All Superinterfaces:

EcsContainerDefinitionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EcsFargateContainerDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:53.951Z")
@Stability(Stable)
public interface EcsFargateContainerDefinitionProps
extends software.amazon.jsii.JsiiSerializable, EcsContainerDefinitionProps

Props to configure an EcsFargateContainerDefinition.

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	Interface	Description
static final class	EcsFargateContainerDefinitionProps.Builder	A builder for EcsFargateContainerDefinitionProps
static final class	EcsFargateContainerDefinitionProps.Jsii$Proxy	An implementation for EcsFargateContainerDefinitionProps

Method Summary

Modifier and Type	Method	Description
static EcsFargateContainerDefinitionProps.Builder	builder()
default Boolean	getAssignPublicIp()	Indicates whether the job has a public IP address.
default Size	getEphemeralStorageSize()	The size for ephemeral storage.
default CpuArchitecture	getFargateCpuArchitecture()	The vCPU architecture of Fargate Runtime.
default OperatingSystemFamily	getFargateOperatingSystemFamily()	The operating system for the compute environment.
default FargatePlatformVersion	getFargatePlatformVersion()	Which version of Fargate to use when running this container.

Methods inherited from interface software.amazon.awscdk.services.batch.EcsContainerDefinitionProps

getCommand, getCpu, getEnvironment, getExecutionRole, getImage, getJobRole, getLinuxParameters, getLogging, getMemory, getReadonlyRootFilesystem, getSecrets, getUser, getVolumes

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssignPublicIp

@Stability(Stable)
@Nullable
default 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.

Default: false

See Also:

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

getEphemeralStorageSize

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

The size for ephemeral storage.

Default: - 20 GiB

getFargateCpuArchitecture

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

The vCPU architecture of Fargate Runtime.

Default: - X86_64

getFargateOperatingSystemFamily

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

The operating system for the compute environment.

Default: - LINUX

getFargatePlatformVersion

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

Which version of Fargate to use when running this container.

Default: LATEST

builder

@Stability(Stable)
static EcsFargateContainerDefinitionProps.Builder builder()

Returns:

a EcsFargateContainerDefinitionProps.Builder of EcsFargateContainerDefinitionProps