Package software.amazon.awscdk.services.ecs

Class FargateTaskDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ecs.TaskDefinition

software.amazon.awscdk.services.ecs.FargateTaskDefinition

All Implemented Interfaces:

IResource, IFargateTaskDefinition, ITaskDefinition, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.569Z")
@Stability(Stable)
public class FargateTaskDefinition
extends TaskDefinition
implements IFargateTaskDefinition

The details of a task definition run on a Fargate cluster.

Example:

 Vpc vpc;
 Cluster cluster = Cluster.Builder.create(this, "FargateCPCluster")
         .vpc(vpc)
         .enableFargateCapacityProviders(true)
         .build();
 FargateTaskDefinition taskDefinition = new FargateTaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("web", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .build());
 FargateService.Builder.create(this, "FargateService")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE_SPOT")
                 .weight(2)
                 .build(), CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE")
                 .weight(1)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.IFargateTaskDefinition

IFargateTaskDefinition.Jsii$Default, IFargateTaskDefinition.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.ITaskDefinition

ITaskDefinition.Jsii$Default, ITaskDefinition.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FargateTaskDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FargateTaskDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	FargateTaskDefinition(software.constructs.Construct scope, String id)	Constructs a new instance of the FargateTaskDefinition class.
	FargateTaskDefinition(software.constructs.Construct scope, String id, FargateTaskDefinitionProps props)	Constructs a new instance of the FargateTaskDefinition class.

Method Summary

Modifier and Type	Method	Description
static IFargateTaskDefinition	fromFargateTaskDefinitionArn(software.constructs.Construct scope, String id, String fargateTaskDefinitionArn)	Imports a task definition from the specified task definition ARN.
static IFargateTaskDefinition	fromFargateTaskDefinitionAttributes(software.constructs.Construct scope, String id, FargateTaskDefinitionAttributes attrs)	Import an existing Fargate task definition from its attributes.
Number	getEphemeralStorageGiB()	The amount (in GiB) of ephemeral storage to be allocated to the task.
NetworkMode	getNetworkMode()	The Docker networking mode to use for the containers in the task.

Methods inherited from class software.amazon.awscdk.services.ecs.TaskDefinition

addContainer, addExtension, addFirelensLogRouter, addInferenceAccelerator, addPlacementConstraint, addToExecutionRolePolicy, addToTaskRolePolicy, addVolume, findContainer, findPortMappingByName, fromTaskDefinitionArn, fromTaskDefinitionAttributes, getCompatibility, getContainers, getDefaultContainer, getExecutionRole, getFamily, getInferenceAccelerators, getIsEc2Compatible, getIsExternalCompatible, getIsFargateCompatible, getPidMode, getReferencesSecretJsonField, getTaskDefinitionArn, getTaskRole, grantRun, obtainExecutionRole, setDefaultContainer

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

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.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

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

getCompatibility, getExecutionRole, getIsEc2Compatible, getIsExternalCompatible, getIsFargateCompatible, getTaskDefinitionArn, getTaskRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

FargateTaskDefinition

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

FargateTaskDefinition

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

FargateTaskDefinition

@Stability(Stable)
public FargateTaskDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 FargateTaskDefinitionProps props)

Constructs a new instance of the FargateTaskDefinition class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

FargateTaskDefinition

@Stability(Stable)
public FargateTaskDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Constructs a new instance of the FargateTaskDefinition class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromFargateTaskDefinitionArn

@Stability(Stable)
@NotNull
public static IFargateTaskDefinition fromFargateTaskDefinitionArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String fargateTaskDefinitionArn)

Imports a task definition from the specified task definition ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

fargateTaskDefinitionArn - This parameter is required.

fromFargateTaskDefinitionAttributes

@Stability(Stable)
@NotNull
public static IFargateTaskDefinition fromFargateTaskDefinitionAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 FargateTaskDefinitionAttributes attrs)

Import an existing Fargate task definition from its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getNetworkMode

@Stability(Stable)
@NotNull
public NetworkMode getNetworkMode()

The Docker networking mode to use for the containers in the task.

Fargate tasks require the awsvpc network mode.

Specified by:

getNetworkMode in interface ITaskDefinition

Overrides:

getNetworkMode in class TaskDefinition

getEphemeralStorageGiB

@Stability(Stable)
@Nullable
public Number getEphemeralStorageGiB()

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

Overrides:

getEphemeralStorageGiB in class TaskDefinition