software.amazon.awscdk.services.ecs

Interface TaskDefinitionProps

All Superinterfaces:

CommonTaskDefinitionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TaskDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.829Z")
 @Stability(value=Experimental)
public interface TaskDefinitionProps
extends software.amazon.jsii.JsiiSerializable, CommonTaskDefinitionProps

(experimental) The properties for task definitions.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TaskDefinitionProps.Builder	builder()
Compatibility	getCompatibility() (experimental) The task launch type compatiblity requirement.
default String	getCpu() (experimental) The number of cpu units used by the task.
default List<InferenceAccelerator>	getInferenceAccelerators() (experimental) The inference accelerators to use for the containers in the task.
default IpcMode	getIpcMode() (experimental) The IPC resource namespace to use for the containers in the task.
default String	getMemoryMiB() (experimental) The amount (in MiB) of memory used by the task.
default NetworkMode	getNetworkMode() (experimental) The networking mode to use for the containers in the task.
default PidMode	getPidMode() (experimental) The process namespace to use for the containers in the task.
default List<PlacementConstraint>	getPlacementConstraints() (experimental) The placement constraints to use for tasks in the service.

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

getCompatibility

@Stability(value=Experimental)
 @NotNull
Compatibility getCompatibility()

(experimental) The task launch type compatiblity requirement.

getCpu

@Stability(value=Experimental)
 @Nullable
default String getCpu()

(experimental) The number of cpu units used by the task.

If you are using the EC2 launch type, this field is optional and any value can be used. If you are 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: - CPU units are not specified.

getInferenceAccelerators

@Stability(value=Experimental)
 @Nullable
default List<InferenceAccelerator> getInferenceAccelerators()

(experimental) The inference accelerators to use for the containers in the task.

Not supported in Fargate.

Default: - No inference accelerators.

getIpcMode

@Stability(value=Experimental)
 @Nullable
default IpcMode getIpcMode()

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

Not supported in Fargate and Windows containers.

Default: - IpcMode used by the task is not specified

getMemoryMiB

@Stability(value=Experimental)
 @Nullable
default String getMemoryMiB()

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

If using the EC2 launch type, this field is optional and any value can be used. If 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: - Memory used by task is not specified.

getNetworkMode

@Stability(value=Experimental)
 @Nullable
default NetworkMode getNetworkMode()

(experimental) The networking mode to use for the containers in the task.

On Fargate, the only supported networking mode is AwsVpc.

Default: - NetworkMode.Bridge for EC2 & External tasks, AwsVpc for Fargate tasks.

getPidMode

@Stability(value=Experimental)
 @Nullable
default PidMode getPidMode()

(experimental) The process namespace to use for the containers in the task.

Not supported in Fargate and Windows containers.

Default: - PidMode used by the task is not specified

getPlacementConstraints

@Stability(value=Experimental)
 @Nullable
default List<PlacementConstraint> getPlacementConstraints()

(experimental) The placement constraints to use for tasks in the service.

You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

Not supported in Fargate.

Default: - No placement constraints.

builder

@Stability(value=Experimental)
static TaskDefinitionProps.Builder builder()

Specified by:

builder in interface CommonTaskDefinitionProps

Returns:

a TaskDefinitionProps.Builder of TaskDefinitionProps