Package software.amazon.awscdk.services.ecs

Class CfnTaskDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ecs.CfnTaskDefinition

All Implemented Interfaces:

IInspectable, ITaskDefinitionRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:19.901Z")
@Stability(Stable)
public class CfnTaskDefinition
extends CfnResource
implements IInspectable, ITaskDefinitionRef, ITaggable

Registers a new task definition from the supplied family and containerDefinitions .

Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .

You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 CfnTaskDefinition cfnTaskDefinition = CfnTaskDefinition.Builder.create(this, "MyCfnTaskDefinition")
         .containerDefinitions(List.of(ContainerDefinitionProperty.builder()
                 .image("image")
                 .name("name")
                 // the properties below are optional
                 .command(List.of("command"))
                 .cpu(123)
                 .credentialSpecs(List.of("credentialSpecs"))
                 .dependsOn(List.of(ContainerDependencyProperty.builder()
                         .condition("condition")
                         .containerName("containerName")
                         .build()))
                 .disableNetworking(false)
                 .dnsSearchDomains(List.of("dnsSearchDomains"))
                 .dnsServers(List.of("dnsServers"))
                 .dockerLabels(Map.of(
                         "dockerLabelsKey", "dockerLabels"))
                 .dockerSecurityOptions(List.of("dockerSecurityOptions"))
                 .entryPoint(List.of("entryPoint"))
                 .environment(List.of(KeyValuePairProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .environmentFiles(List.of(EnvironmentFileProperty.builder()
                         .type("type")
                         .value("value")
                         .build()))
                 .essential(false)
                 .extraHosts(List.of(HostEntryProperty.builder()
                         .hostname("hostname")
                         .ipAddress("ipAddress")
                         .build()))
                 .firelensConfiguration(FirelensConfigurationProperty.builder()
                         .options(Map.of(
                                 "optionsKey", "options"))
                         .type("type")
                         .build())
                 .healthCheck(HealthCheckProperty.builder()
                         .command(List.of("command"))
                         .interval(123)
                         .retries(123)
                         .startPeriod(123)
                         .timeout(123)
                         .build())
                 .hostname("hostname")
                 .interactive(false)
                 .links(List.of("links"))
                 .linuxParameters(LinuxParametersProperty.builder()
                         .capabilities(KernelCapabilitiesProperty.builder()
                                 .add(List.of("add"))
                                 .drop(List.of("drop"))
                                 .build())
                         .devices(List.of(DeviceProperty.builder()
                                 .containerPath("containerPath")
                                 .hostPath("hostPath")
                                 .permissions(List.of("permissions"))
                                 .build()))
                         .initProcessEnabled(false)
                         .maxSwap(123)
                         .sharedMemorySize(123)
                         .swappiness(123)
                         .tmpfs(List.of(TmpfsProperty.builder()
                                 .size(123)
                                 // the properties below are optional
                                 .containerPath("containerPath")
                                 .mountOptions(List.of("mountOptions"))
                                 .build()))
                         .build())
                 .logConfiguration(LogConfigurationProperty.builder()
                         .logDriver("logDriver")
                         // the properties below are optional
                         .options(Map.of(
                                 "optionsKey", "options"))
                         .secretOptions(List.of(SecretProperty.builder()
                                 .name("name")
                                 .valueFrom("valueFrom")
                                 .build()))
                         .build())
                 .memory(123)
                 .memoryReservation(123)
                 .mountPoints(List.of(MountPointProperty.builder()
                         .containerPath("containerPath")
                         .readOnly(false)
                         .sourceVolume("sourceVolume")
                         .build()))
                 .portMappings(List.of(PortMappingProperty.builder()
                         .appProtocol("appProtocol")
                         .containerPort(123)
                         .containerPortRange("containerPortRange")
                         .hostPort(123)
                         .name("name")
                         .protocol("protocol")
                         .build()))
                 .privileged(false)
                 .pseudoTerminal(false)
                 .readonlyRootFilesystem(false)
                 .repositoryCredentials(RepositoryCredentialsProperty.builder()
                         .credentialsParameter("credentialsParameter")
                         .build())
                 .resourceRequirements(List.of(ResourceRequirementProperty.builder()
                         .type("type")
                         .value("value")
                         .build()))
                 .restartPolicy(RestartPolicyProperty.builder()
                         .enabled(false)
                         .ignoredExitCodes(List.of(123))
                         .restartAttemptPeriod(123)
                         .build())
                 .secrets(List.of(SecretProperty.builder()
                         .name("name")
                         .valueFrom("valueFrom")
                         .build()))
                 .startTimeout(123)
                 .stopTimeout(123)
                 .systemControls(List.of(SystemControlProperty.builder()
                         .namespace("namespace")
                         .value("value")
                         .build()))
                 .ulimits(List.of(UlimitProperty.builder()
                         .hardLimit(123)
                         .name("name")
                         .softLimit(123)
                         .build()))
                 .user("user")
                 .versionConsistency("versionConsistency")
                 .volumesFrom(List.of(VolumeFromProperty.builder()
                         .readOnly(false)
                         .sourceContainer("sourceContainer")
                         .build()))
                 .workingDirectory("workingDirectory")
                 .build()))
         .cpu("cpu")
         .enableFaultInjection(false)
         .ephemeralStorage(EphemeralStorageProperty.builder()
                 .sizeInGiB(123)
                 .build())
         .executionRoleArn("executionRoleArn")
         .family("family")
         .inferenceAccelerators(List.of(InferenceAcceleratorProperty.builder()
                 .deviceName("deviceName")
                 .deviceType("deviceType")
                 .build()))
         .ipcMode("ipcMode")
         .memory("memory")
         .networkMode("networkMode")
         .pidMode("pidMode")
         .placementConstraints(List.of(TaskDefinitionPlacementConstraintProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .expression("expression")
                 .build()))
         .proxyConfiguration(ProxyConfigurationProperty.builder()
                 .containerName("containerName")
                 // the properties below are optional
                 .proxyConfigurationProperties(List.of(KeyValuePairProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .type("type")
                 .build())
         .requiresCompatibilities(List.of("requiresCompatibilities"))
         .runtimePlatform(RuntimePlatformProperty.builder()
                 .cpuArchitecture("cpuArchitecture")
                 .operatingSystemFamily("operatingSystemFamily")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskRoleArn("taskRoleArn")
         .volumes(List.of(VolumeProperty.builder()
                 .configuredAtLaunch(false)
                 .dockerVolumeConfiguration(DockerVolumeConfigurationProperty.builder()
                         .autoprovision(false)
                         .driver("driver")
                         .driverOpts(Map.of(
                                 "driverOptsKey", "driverOpts"))
                         .labels(Map.of(
                                 "labelsKey", "labels"))
                         .scope("scope")
                         .build())
                 .efsVolumeConfiguration(EFSVolumeConfigurationProperty.builder()
                         .filesystemId("filesystemId")
                         // the properties below are optional
                         .authorizationConfig(AuthorizationConfigProperty.builder()
                                 .accessPointId("accessPointId")
                                 .iam("iam")
                                 .build())
                         .rootDirectory("rootDirectory")
                         .transitEncryption("transitEncryption")
                         .transitEncryptionPort(123)
                         .build())
                 .fSxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfigurationProperty.builder()
                         .fileSystemId("fileSystemId")
                         .rootDirectory("rootDirectory")
                         // the properties below are optional
                         .authorizationConfig(FSxAuthorizationConfigProperty.builder()
                                 .credentialsParameter("credentialsParameter")
                                 .domain("domain")
                                 .build())
                         .build())
                 .host(HostVolumePropertiesProperty.builder()
                         .sourcePath("sourcePath")
                         .build())
                 .name("name")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnTaskDefinition.AuthorizationConfigProperty	The authorization configuration details for the Amazon EFS file system.
static final class	CfnTaskDefinition.Builder	A fluent builder for CfnTaskDefinition.
static interface	CfnTaskDefinition.ContainerDefinitionProperty	The ContainerDefinition property specifies a container definition.
static interface	CfnTaskDefinition.ContainerDependencyProperty	The ContainerDependency property specifies the dependencies defined for container startup and shutdown.
static interface	CfnTaskDefinition.DeviceProperty	The Device property specifies an object representing a container instance host device.
static interface	CfnTaskDefinition.DockerVolumeConfigurationProperty	The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes.
static interface	CfnTaskDefinition.EFSVolumeConfigurationProperty	This parameter is specified when you're using an Amazon Elastic File System file system for task storage.
static interface	CfnTaskDefinition.EnvironmentFileProperty	A list of files containing the environment variables to pass to a container.
static interface	CfnTaskDefinition.EphemeralStorageProperty	The amount of ephemeral storage to allocate for the task.
static interface	CfnTaskDefinition.FirelensConfigurationProperty	The FireLens configuration for the container.
static interface	CfnTaskDefinition.FSxAuthorizationConfigProperty	The authorization configuration details for Amazon FSx for Windows File Server file system.
static interface	CfnTaskDefinition.FSxWindowsFileServerVolumeConfigurationProperty	This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage.
static interface	CfnTaskDefinition.HealthCheckProperty	The HealthCheck property specifies an object representing a container health check.
static interface	CfnTaskDefinition.HostEntryProperty	The HostEntry property specifies a hostname and an IP address that are added to the /etc/hosts file of a container through the extraHosts parameter of its ContainerDefinition resource.
static interface	CfnTaskDefinition.HostVolumePropertiesProperty	The HostVolumeProperties property specifies details on a container instance bind mount host volume.
static interface	CfnTaskDefinition.InferenceAcceleratorProperty	Example:
static interface	CfnTaskDefinition.KernelCapabilitiesProperty	The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition.
static interface	CfnTaskDefinition.KeyValuePairProperty	A key-value pair object.
static interface	CfnTaskDefinition.LinuxParametersProperty	The Linux-specific options that are applied to the container, such as Linux KernelCapabilities .
static interface	CfnTaskDefinition.LogConfigurationProperty	The LogConfiguration property specifies log configuration options to send to a custom log driver for the container.
static interface	CfnTaskDefinition.MountPointProperty	The details for a volume mount point that's used in a container definition.
static interface	CfnTaskDefinition.PortMappingProperty	The PortMapping property specifies a port mapping.
static interface	CfnTaskDefinition.ProxyConfigurationProperty	The configuration details for the App Mesh proxy.
static interface	CfnTaskDefinition.RepositoryCredentialsProperty	The repository credentials for private registry authentication.
static interface	CfnTaskDefinition.ResourceRequirementProperty	The type and amount of a resource to assign to a container.
static interface	CfnTaskDefinition.RestartPolicyProperty	You can enable a restart policy for each container defined in your task definition, to overcome transient failures faster and maintain task availability.
static interface	CfnTaskDefinition.RuntimePlatformProperty	Information about the platform for the Amazon ECS service or task.
static interface	CfnTaskDefinition.SecretProperty	An object representing the secret to expose to your container.
static interface	CfnTaskDefinition.SystemControlProperty	A list of namespaced kernel parameters to set in the container.
static interface	CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty	The constraint on task placement in the task definition.
static interface	CfnTaskDefinition.TmpfsProperty	The container path, mount options, and size of the tmpfs mount.
static interface	CfnTaskDefinition.UlimitProperty	The ulimit settings to pass to the container.
static interface	CfnTaskDefinition.VolumeFromProperty	Details on a data volume from another container in the same task definition.
static interface	CfnTaskDefinition.VolumeProperty	The data volume configuration for tasks launched using this task definition.

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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

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

ITaskDefinitionRef.Jsii$Default, ITaskDefinitionRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTaskDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTaskDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTaskDefinition(software.constructs.Construct scope, String id)	Create a new AWS::ECS::TaskDefinition.
	CfnTaskDefinition(software.constructs.Construct scope, String id, CfnTaskDefinitionProps props)	Create a new AWS::ECS::TaskDefinition.

Method Summary

Modifier and Type	Method	Description
static String	arnForTaskDefinition(ITaskDefinitionRef resource)
String	getAttrTaskDefinitionArn()	The ARN of the task definition.
protected Map<String,Object>	getCfnProperties()
Object	getContainerDefinitions()	A list of container definitions in JSON format that describe the different containers that make up your task.
String	getCpu()	The number of cpu units used by the task.
Object	getEnableFaultInjection()	Enables fault injection and allows for fault injection requests to be accepted from the task's containers.
Object	getEphemeralStorage()	The ephemeral storage settings to use for tasks run with the task definition.
String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.
String	getFamily()	The name of a family that this task definition is registered to.
Object	getInferenceAccelerators()	Deprecated. this property has been deprecated
String	getIpcMode()	The IPC resource namespace to use for the containers in the task.
String	getMemory()	The amount (in MiB) of memory used by the task.
String	getNetworkMode()	The Docker networking mode to use for the containers in the task.
String	getPidMode()	The process namespace to use for the containers in the task.
Object	getPlacementConstraints()	An array of placement constraint objects to use for tasks.
Object	getProxyConfiguration()	The configuration details for the App Mesh proxy.
List<String>	getRequiresCompatibilities()	The task launch types the task definition was validated against.
Object	getRuntimePlatform()	The operating system that your tasks definitions run on.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The metadata that you apply to the task definition to help you categorize and organize them.
TaskDefinitionReference	getTaskDefinitionRef()	A reference to a TaskDefinition resource.
String	getTaskRoleArn()	The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.
Object	getVolumes()	The list of data volume definitions for the task.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnTaskDefinition(Object x)	Checks whether the given object is a CfnTaskDefinition.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainerDefinitions(List<Object> value)	A list of container definitions in JSON format that describe the different containers that make up your task.
void	setContainerDefinitions(IResolvable value)	A list of container definitions in JSON format that describe the different containers that make up your task.
void	setCpu(String value)	The number of cpu units used by the task.
void	setEnableFaultInjection(Boolean value)	Enables fault injection and allows for fault injection requests to be accepted from the task's containers.
void	setEnableFaultInjection(IResolvable value)	Enables fault injection and allows for fault injection requests to be accepted from the task's containers.
void	setEphemeralStorage(IResolvable value)	The ephemeral storage settings to use for tasks run with the task definition.
void	setEphemeralStorage(CfnTaskDefinition.EphemeralStorageProperty value)	The ephemeral storage settings to use for tasks run with the task definition.
void	setExecutionRoleArn(String value)	The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.
void	setFamily(String value)	The name of a family that this task definition is registered to.
void	setInferenceAccelerators(List<Object> value)	Deprecated. this property has been deprecated
void	setInferenceAccelerators(IResolvable value)	Deprecated. this property has been deprecated
void	setIpcMode(String value)	The IPC resource namespace to use for the containers in the task.
void	setMemory(String value)	The amount (in MiB) of memory used by the task.
void	setNetworkMode(String value)	The Docker networking mode to use for the containers in the task.
void	setPidMode(String value)	The process namespace to use for the containers in the task.
void	setPlacementConstraints(List<Object> value)	An array of placement constraint objects to use for tasks.
void	setPlacementConstraints(IResolvable value)	An array of placement constraint objects to use for tasks.
void	setProxyConfiguration(IResolvable value)	The configuration details for the App Mesh proxy.
void	setProxyConfiguration(CfnTaskDefinition.ProxyConfigurationProperty value)	The configuration details for the App Mesh proxy.
void	setRequiresCompatibilities(List<String> value)	The task launch types the task definition was validated against.
void	setRuntimePlatform(IResolvable value)	The operating system that your tasks definitions run on.
void	setRuntimePlatform(CfnTaskDefinition.RuntimePlatformProperty value)	The operating system that your tasks definitions run on.
void	setTagsRaw(List<CfnTag> value)	The metadata that you apply to the task definition to help you categorize and organize them.
void	setTaskRoleArn(String value)	The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.
void	setVolumes(List<Object> value)	The list of data volume definitions for the task.
void	setVolumes(IResolvable value)	The list of data volume definitions for the task.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTaskDefinition

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

CfnTaskDefinition

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

CfnTaskDefinition

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

Create a new AWS::ECS::TaskDefinition.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnTaskDefinition

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

Create a new AWS::ECS::TaskDefinition.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

arnForTaskDefinition

@Stability(Stable)
@NotNull
public static String arnForTaskDefinition(@NotNull
 ITaskDefinitionRef resource)

Parameters:

resource - This parameter is required.

isCfnTaskDefinition

@Stability(Stable)
@NotNull
public static Boolean isCfnTaskDefinition(@NotNull
 Object x)

Checks whether the given object is a CfnTaskDefinition.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrTaskDefinitionArn

@Stability(Stable)
@NotNull
public String getAttrTaskDefinitionArn()

The ARN of the task definition.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getTaskDefinitionRef

@Stability(Stable)
@NotNull
public TaskDefinitionReference getTaskDefinitionRef()

A reference to a TaskDefinition resource.

Specified by:

getTaskDefinitionRef in interface ITaskDefinitionRef

getContainerDefinitions

@Stability(Stable)
@Nullable
public Object getContainerDefinitions()

A list of container definitions in JSON format that describe the different containers that make up your task.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskDefinition.ContainerDefinitionProperty>

setContainerDefinitions

@Stability(Stable)
public void setContainerDefinitions(@Nullable
 IResolvable value)

A list of container definitions in JSON format that describe the different containers that make up your task.

setContainerDefinitions

@Stability(Stable)
public void setContainerDefinitions(@Nullable
 List<Object> value)

A list of container definitions in JSON format that describe the different containers that make up your task.

getCpu

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

The number of cpu units used by the task.

setCpu

@Stability(Stable)
public void setCpu(@Nullable
 String value)

The number of cpu units used by the task.

getEnableFaultInjection

@Stability(Stable)
@Nullable
public Object getEnableFaultInjection()

Enables fault injection and allows for fault injection requests to be accepted from the task's containers.

Returns union: either Boolean or IResolvable

setEnableFaultInjection

@Stability(Stable)
public void setEnableFaultInjection(@Nullable
 Boolean value)

Enables fault injection and allows for fault injection requests to be accepted from the task's containers.

setEnableFaultInjection

@Stability(Stable)
public void setEnableFaultInjection(@Nullable
 IResolvable value)

Enables fault injection and allows for fault injection requests to be accepted from the task's containers.

getEphemeralStorage

@Stability(Stable)
@Nullable
public Object getEphemeralStorage()

The ephemeral storage settings to use for tasks run with the task definition.

Returns union: either IResolvable or CfnTaskDefinition.EphemeralStorageProperty

setEphemeralStorage

@Stability(Stable)
public void setEphemeralStorage(@Nullable
 IResolvable value)

The ephemeral storage settings to use for tasks run with the task definition.

setEphemeralStorage

@Stability(Stable)
public void setEphemeralStorage(@Nullable
 CfnTaskDefinition.EphemeralStorageProperty value)

The ephemeral storage settings to use for tasks run with the task definition.

getExecutionRoleArn

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

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.

setExecutionRoleArn

@Stability(Stable)
public void setExecutionRoleArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.

getFamily

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

The name of a family that this task definition is registered to.

setFamily

@Stability(Stable)
public void setFamily(@Nullable
 String value)

The name of a family that this task definition is registered to.

getInferenceAccelerators

@Stability(Deprecated)
@Deprecated
@Nullable
public Object getInferenceAccelerators()

Deprecated.

this property has been deprecated

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskDefinition.InferenceAcceleratorProperty>

setInferenceAccelerators

@Stability(Deprecated)
@Deprecated
public void setInferenceAccelerators(@Nullable
 IResolvable value)

Deprecated.

this property has been deprecated

setInferenceAccelerators

@Stability(Deprecated)
@Deprecated
public void setInferenceAccelerators(@Nullable
 List<Object> value)

Deprecated.

this property has been deprecated

getIpcMode

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

The IPC resource namespace to use for the containers in the task.

setIpcMode

@Stability(Stable)
public void setIpcMode(@Nullable
 String value)

The IPC resource namespace to use for the containers in the task.

getMemory

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

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

setMemory

@Stability(Stable)
public void setMemory(@Nullable
 String value)

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

getNetworkMode

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

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

setNetworkMode

@Stability(Stable)
public void setNetworkMode(@Nullable
 String value)

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

getPidMode

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

The process namespace to use for the containers in the task.

setPidMode

@Stability(Stable)
public void setPidMode(@Nullable
 String value)

The process namespace to use for the containers in the task.

getPlacementConstraints

@Stability(Stable)
@Nullable
public Object getPlacementConstraints()

An array of placement constraint objects to use for tasks.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty>

setPlacementConstraints

@Stability(Stable)
public void setPlacementConstraints(@Nullable
 IResolvable value)

An array of placement constraint objects to use for tasks.

setPlacementConstraints

@Stability(Stable)
public void setPlacementConstraints(@Nullable
 List<Object> value)

An array of placement constraint objects to use for tasks.

getProxyConfiguration

@Stability(Stable)
@Nullable
public Object getProxyConfiguration()

The configuration details for the App Mesh proxy.

Returns union: either IResolvable or CfnTaskDefinition.ProxyConfigurationProperty

setProxyConfiguration

@Stability(Stable)
public void setProxyConfiguration(@Nullable
 IResolvable value)

The configuration details for the App Mesh proxy.

setProxyConfiguration

@Stability(Stable)
public void setProxyConfiguration(@Nullable
 CfnTaskDefinition.ProxyConfigurationProperty value)

The configuration details for the App Mesh proxy.

getRequiresCompatibilities

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

The task launch types the task definition was validated against.

setRequiresCompatibilities

@Stability(Stable)
public void setRequiresCompatibilities(@Nullable
 List<String> value)

The task launch types the task definition was validated against.

getRuntimePlatform

@Stability(Stable)
@Nullable
public Object getRuntimePlatform()

The operating system that your tasks definitions run on.

Returns union: either IResolvable or CfnTaskDefinition.RuntimePlatformProperty

setRuntimePlatform

@Stability(Stable)
public void setRuntimePlatform(@Nullable
 IResolvable value)

The operating system that your tasks definitions run on.

setRuntimePlatform

@Stability(Stable)
public void setRuntimePlatform(@Nullable
 CfnTaskDefinition.RuntimePlatformProperty value)

The operating system that your tasks definitions run on.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The metadata that you apply to the task definition to help you categorize and organize them.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The metadata that you apply to the task definition to help you categorize and organize them.

getTaskRoleArn

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

The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.

setTaskRoleArn

@Stability(Stable)
public void setTaskRoleArn(@Nullable
 String value)

The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.

getVolumes

@Stability(Stable)
@Nullable
public Object getVolumes()

The list of data volume definitions for the task.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskDefinition.VolumeProperty>

setVolumes

@Stability(Stable)
public void setVolumes(@Nullable
 IResolvable value)

The list of data volume definitions for the task.

setVolumes

@Stability(Stable)
public void setVolumes(@Nullable
 List<Object> value)

The list of data volume definitions for the task.