Package software.amazon.awscdk.services.ecs

Interface ITaskDefinition

All Superinterfaces:

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

All Known Subinterfaces:

IEc2TaskDefinition, IEc2TaskDefinition.Jsii$Default, IExternalTaskDefinition, IExternalTaskDefinition.Jsii$Default, IFargateTaskDefinition, IFargateTaskDefinition.Jsii$Default, ITaskDefinition.Jsii$Default

All Known Implementing Classes:

Ec2TaskDefinition, ExternalTaskDefinition, FargateTaskDefinition, IEc2TaskDefinition.Jsii$Proxy, IExternalTaskDefinition.Jsii$Proxy, IFargateTaskDefinition.Jsii$Proxy, ITaskDefinition.Jsii$Proxy, TaskDefinition

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.402Z")
@Stability(Stable)
public interface ITaskDefinition
extends software.amazon.jsii.JsiiSerializable, IResource

The interface for all task definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ITaskDefinition.Jsii$Default	Internal default implementation for ITaskDefinition.
static final class	ITaskDefinition.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
Compatibility	getCompatibility()	What launch types this task definition should be compatible with.
default IRole	getExecutionRole()	Execution role for this task definition.
Boolean	getIsEc2Compatible()	Return true if the task definition can be run on an EC2 cluster.
Boolean	getIsExternalCompatible()	Return true if the task definition can be run on a ECS Anywhere cluster.
Boolean	getIsFargateCompatible()	Return true if the task definition can be run on a Fargate cluster.
NetworkMode	getNetworkMode()	The networking mode to use for the containers in the task.
String	getTaskDefinitionArn()	ARN of this task definition.
IRole	getTaskRole()	The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCompatibility

@Stability(Stable)
@NotNull
Compatibility getCompatibility()

What launch types this task definition should be compatible with.

getIsEc2Compatible

@Stability(Stable)
@NotNull
Boolean getIsEc2Compatible()

Return true if the task definition can be run on an EC2 cluster.

getIsExternalCompatible

@Stability(Stable)
@NotNull
Boolean getIsExternalCompatible()

Return true if the task definition can be run on a ECS Anywhere cluster.

getIsFargateCompatible

@Stability(Stable)
@NotNull
Boolean getIsFargateCompatible()

Return true if the task definition can be run on a Fargate cluster.

getNetworkMode

@Stability(Stable)
@NotNull
NetworkMode getNetworkMode()

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

getTaskDefinitionArn

@Stability(Stable)
@NotNull
String getTaskDefinitionArn()

ARN of this task definition.

getTaskRole

@Stability(Stable)
@NotNull
IRole getTaskRole()

The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

getExecutionRole

@Stability(Stable)
@Nullable
default IRole getExecutionRole()

Execution role for this task definition.