Class FargateTaskDefinition.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<FargateTaskDefinition>
- Enclosing class:
FargateTaskDefinition
FargateTaskDefinition
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
The number of cpu units used by the task.ephemeralStorageGiB
(Number ephemeralStorageGiB) The amount (in GiB) of ephemeral storage to be allocated to the task.executionRole
(IRole executionRole) The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf.The name of a family that this task definition is registered to.memoryLimitMiB
(Number memoryLimitMiB) The amount (in MiB) of memory used by the task.The process namespace to use for the containers in the task.proxyConfiguration
(ProxyConfiguration proxyConfiguration) The configuration details for the App Mesh proxy.runtimePlatform
(RuntimePlatform runtimePlatform) The operating system that your task definitions are running on.The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.The list of volume definitions for the task.
-
Method Details
-
create
@Stability(Stable) public static FargateTaskDefinition.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
FargateTaskDefinition.Builder
.
-
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.
Default: - An execution role will be automatically created if you use ECR images in your task definition.
- Parameters:
executionRole
- The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. This parameter is required.- Returns:
this
-
family
The name of a family that this task definition is registered to.A family groups multiple versions of a task definition.
Default: - Automatically generated name.
- Parameters:
family
- The name of a family that this task definition is registered to. This parameter is required.- Returns:
this
-
proxyConfiguration
@Stability(Stable) public FargateTaskDefinition.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration) The configuration details for the App Mesh proxy.Default: - No proxy configuration.
- Parameters:
proxyConfiguration
- The configuration details for the App Mesh proxy. This parameter is required.- Returns:
this
-
taskRole
The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.Default: - A task role is automatically created for you.
- Parameters:
taskRole
- The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. This parameter is required.- Returns:
this
-
volumes
The list of volume definitions for the task.For more information, see Task Definition Parameter Volumes.
Default: - No volumes are passed to the Docker daemon on a container instance.
- Parameters:
volumes
- The list of volume definitions for the task. This parameter is required.- Returns:
this
-
cpu
The number of cpu units used by the task.For tasks 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)
8192 (8 vCPU) - Available memory values: Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB)
16384 (16 vCPU) - Available memory values: Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB)
Default: 256
- Parameters:
cpu
- The number of cpu units used by the task. This parameter is required.- Returns:
this
-
ephemeralStorageGiB
@Stability(Stable) public FargateTaskDefinition.Builder ephemeralStorageGiB(Number ephemeralStorageGiB) The amount (in GiB) of ephemeral storage to be allocated to the task.The maximum supported value is 200 GiB.
NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later.
Default: 20
- Parameters:
ephemeralStorageGiB
- The amount (in GiB) of ephemeral storage to be allocated to the task. This parameter is required.- Returns:
this
-
memoryLimitMiB
The amount (in MiB) of memory used by the task.For tasks 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)
Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)
Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
Default: 512
- Parameters:
memoryLimitMiB
- The amount (in MiB) of memory used by the task. This parameter is required.- Returns:
this
-
pidMode
The process namespace to use for the containers in the task.Only supported for tasks that are hosted on AWS Fargate if the tasks are using platform version 1.4.0 or later (Linux). Only the TASK option is supported for Linux-based Fargate containers. Not supported in Windows containers. If pidMode is specified for a Fargate task, then runtimePlatform.operatingSystemFamily must also be specified. For more information, see Task Definition Parameters.
Default: - PidMode used by the task is not specified
- Parameters:
pidMode
- The process namespace to use for the containers in the task. This parameter is required.- Returns:
this
-
runtimePlatform
@Stability(Stable) public FargateTaskDefinition.Builder runtimePlatform(RuntimePlatform runtimePlatform) The operating system that your task definitions are running on.A runtimePlatform is supported only for tasks using the Fargate launch type.
Default: - Undefined.
- Parameters:
runtimePlatform
- The operating system that your task definitions are running on. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<FargateTaskDefinition>
- Returns:
- a newly built instance of
FargateTaskDefinition
.
-