Class TaskDefinitionProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<TaskDefinitionProps>
- Enclosing interface:
- TaskDefinitionProps
TaskDefinitionProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.compatibility
(Compatibility compatibility) Sets the value ofTaskDefinitionProps.getCompatibility()
Sets the value ofTaskDefinitionProps.getCpu()
ephemeralStorageGiB
(Number ephemeralStorageGiB) Sets the value ofTaskDefinitionProps.getEphemeralStorageGiB()
executionRole
(IRole executionRole) Sets the value ofCommonTaskDefinitionProps.getExecutionRole()
Sets the value ofCommonTaskDefinitionProps.getFamily()
inferenceAccelerators
(List<? extends InferenceAccelerator> inferenceAccelerators) Sets the value ofTaskDefinitionProps.getInferenceAccelerators()
Sets the value ofTaskDefinitionProps.getIpcMode()
Sets the value ofTaskDefinitionProps.getMemoryMiB()
networkMode
(NetworkMode networkMode) Sets the value ofTaskDefinitionProps.getNetworkMode()
Sets the value ofTaskDefinitionProps.getPidMode()
placementConstraints
(List<? extends PlacementConstraint> placementConstraints) Sets the value ofTaskDefinitionProps.getPlacementConstraints()
proxyConfiguration
(ProxyConfiguration proxyConfiguration) Sets the value ofCommonTaskDefinitionProps.getProxyConfiguration()
runtimePlatform
(RuntimePlatform runtimePlatform) Sets the value ofTaskDefinitionProps.getRuntimePlatform()
Sets the value ofCommonTaskDefinitionProps.getTaskRole()
Sets the value ofCommonTaskDefinitionProps.getVolumes()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
compatibility
Sets the value ofTaskDefinitionProps.getCompatibility()
- Parameters:
compatibility
- The task launch type compatiblity requirement. This parameter is required.- Returns:
this
-
cpu
Sets the value ofTaskDefinitionProps.getCpu()
- Parameters:
cpu
- 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)
- Returns:
this
-
ephemeralStorageGiB
@Stability(Stable) public TaskDefinitionProps.Builder ephemeralStorageGiB(Number ephemeralStorageGiB) Sets the value ofTaskDefinitionProps.getEphemeralStorageGiB()
- Parameters:
ephemeralStorageGiB
- The amount (in GiB) of ephemeral storage to be allocated to the task. Only supported in Fargate platform version 1.4.0 or later.- Returns:
this
-
inferenceAccelerators
@Stability(Stable) public TaskDefinitionProps.Builder inferenceAccelerators(List<? extends InferenceAccelerator> inferenceAccelerators) Sets the value ofTaskDefinitionProps.getInferenceAccelerators()
- Parameters:
inferenceAccelerators
- The inference accelerators to use for the containers in the task. Not supported in Fargate.- Returns:
this
-
ipcMode
Sets the value ofTaskDefinitionProps.getIpcMode()
- Parameters:
ipcMode
- The IPC resource namespace to use for the containers in the task. Not supported in Fargate and Windows containers.- Returns:
this
-
memoryMiB
Sets the value ofTaskDefinitionProps.getMemoryMiB()
- Parameters:
memoryMiB
- 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)
- Returns:
this
-
networkMode
Sets the value ofTaskDefinitionProps.getNetworkMode()
- Parameters:
networkMode
- The networking mode to use for the containers in the task. On Fargate, the only supported networking mode is AwsVpc.- Returns:
this
-
pidMode
Sets the value ofTaskDefinitionProps.getPidMode()
- Parameters:
pidMode
- The process namespace to use for the containers in the task. Not supported in Fargate and Windows containers.- Returns:
this
-
placementConstraints
@Stability(Stable) public TaskDefinitionProps.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints) Sets the value ofTaskDefinitionProps.getPlacementConstraints()
- Parameters:
placementConstraints
- 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.
- Returns:
this
-
runtimePlatform
@Stability(Stable) public TaskDefinitionProps.Builder runtimePlatform(RuntimePlatform runtimePlatform) Sets the value ofTaskDefinitionProps.getRuntimePlatform()
- Parameters:
runtimePlatform
- The operating system that your task definitions are running on. A runtimePlatform is supported only for tasks using the Fargate launch type.- Returns:
this
-
executionRole
Sets the value ofCommonTaskDefinitionProps.getExecutionRole()
- Parameters:
executionRole
- The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. The role will be used to retrieve container images from ECR and create CloudWatch log groups.- Returns:
this
-
family
Sets the value ofCommonTaskDefinitionProps.getFamily()
- Parameters:
family
- The name of a family that this task definition is registered to. A family groups multiple versions of a task definition.- Returns:
this
-
proxyConfiguration
@Stability(Stable) public TaskDefinitionProps.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration) Sets the value ofCommonTaskDefinitionProps.getProxyConfiguration()
- Parameters:
proxyConfiguration
- The configuration details for the App Mesh proxy.- Returns:
this
-
taskRole
Sets the value ofCommonTaskDefinitionProps.getTaskRole()
- Parameters:
taskRole
- The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.- Returns:
this
-
volumes
Sets the value ofCommonTaskDefinitionProps.getVolumes()
- Parameters:
volumes
- The list of volume definitions for the task. For more information, see Task Definition Parameter Volumes.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<TaskDefinitionProps>
- Returns:
- a new instance of
TaskDefinitionProps
- Throws:
NullPointerException
- if any required attribute was not provided
-