software.amazon.awscdk.services.ecs

Interface FargateTaskDefinitionProps

All Superinterfaces:

CommonTaskDefinitionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FargateTaskDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.706Z")
 @Stability(value=Stable)
public interface FargateTaskDefinitionProps
extends software.amazon.jsii.JsiiSerializable, CommonTaskDefinitionProps

The properties for a task definition.

Example:

 FargateTaskDefinition fargateTaskDefinition = FargateTaskDefinition.Builder.create(this, "TaskDef")
         .memoryLimitMiB(512)
         .cpu(256)
         .build();
 ContainerDefinition container = fargateTaskDefinition.addContainer("WebContainer", ContainerDefinitionOptions.builder()
         // Use an image from DockerHub
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FargateTaskDefinitionProps.Builder A builder for FargateTaskDefinitionProps
static class	FargateTaskDefinitionProps.Jsii$Proxy An implementation for FargateTaskDefinitionProps

Method Summary

Modifier and Type	Method and Description
static FargateTaskDefinitionProps.Builder	builder()
default Number	getCpu() The number of cpu units used by the task.
default Number	getEphemeralStorageGiB() The amount (in GiB) of ephemeral storage to be allocated to the task.
default Number	getMemoryLimitMiB() The amount (in MiB) of memory used by the task.
default RuntimePlatform	getRuntimePlatform() The operating system that your task definitions are running on.

Methods inherited from interface software.amazon.awscdk.services.ecs.CommonTaskDefinitionProps

getExecutionRole, getFamily, getProxyConfiguration, getTaskRole, getVolumes

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCpu

@Stability(value=Stable)
 @Nullable
default Number getCpu()

The number of cpu units used by the task.

For tasks using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

Default: 256

getEphemeralStorageGiB

@Stability(value=Stable)
 @Nullable
default Number getEphemeralStorageGiB()

The amount (in GiB) of ephemeral storage to be allocated to the task.

The maximum supported value is 200 GiB.

NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later.

Default: 20

getMemoryLimitMiB

@Stability(value=Stable)
 @Nullable
default Number getMemoryLimitMiB()

The amount (in MiB) of memory used by the task.

For tasks using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

Default: 512

getRuntimePlatform

@Stability(value=Stable)
 @Nullable
default RuntimePlatform getRuntimePlatform()

The operating system that your task definitions are running on.

A runtimePlatform is supported only for tasks using the Fargate launch type.

Default: - Undefined.

builder

@Stability(value=Stable)
static FargateTaskDefinitionProps.Builder builder()

Specified by:

builder in interface CommonTaskDefinitionProps

Returns:

a FargateTaskDefinitionProps.Builder of FargateTaskDefinitionProps