software.amazon.awscdk.services.ecs

Class FargateTaskDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.FargateTaskDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateTaskDefinition>

Enclosing class:

FargateTaskDefinition

@Stability(value=Stable)
public static final class FargateTaskDefinition.Builder
extends Object
implements software.amazon.jsii.Builder<FargateTaskDefinition>

A fluent builder for FargateTaskDefinition.

Method Summary

Modifier and Type	Method and Description
FargateTaskDefinition	build()
FargateTaskDefinition.Builder	cpu(Number cpu) The number of cpu units used by the task.
static FargateTaskDefinition.Builder	create(software.constructs.Construct scope, String id)
FargateTaskDefinition.Builder	executionRole(IRole executionRole) The name of the IAM task execution role that grants the ECS agent to call AWS APIs on your behalf.
FargateTaskDefinition.Builder	family(String family) The name of a family that this task definition is registered to.
FargateTaskDefinition.Builder	memoryLimitMiB(Number memoryLimitMiB) The amount (in MiB) of memory used by the task.
FargateTaskDefinition.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration) The configuration details for the App Mesh proxy.
FargateTaskDefinition.Builder	taskRole(IRole taskRole) The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
FargateTaskDefinition.Builder	volumes(List<? extends Volume> volumes) The list of volume definitions for the task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=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

@Stability(value=Stable)
public FargateTaskDefinition.Builder executionRole(IRole executionRole)

The name of the IAM task execution role that grants the ECS agent 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 to call AWS APIs on your behalf. This parameter is required.

Returns:

this

family

@Stability(value=Stable)
public FargateTaskDefinition.Builder family(String 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(value=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

@Stability(value=Stable)
public FargateTaskDefinition.Builder taskRole(IRole 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

@Stability(value=Stable)
public FargateTaskDefinition.Builder volumes(List<? extends Volume> 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

@Stability(value=Stable)
public FargateTaskDefinition.Builder cpu(Number 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)

Default: 256

Parameters:

cpu - The number of cpu units used by the task. This parameter is required.

Returns:

this

memoryLimitMiB

@Stability(value=Stable)
public FargateTaskDefinition.Builder memoryLimitMiB(Number 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)

Default: 512

Parameters:

memoryLimitMiB - The amount (in MiB) of memory used by the task. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public FargateTaskDefinition build()

Specified by:

build in interface software.amazon.jsii.Builder<FargateTaskDefinition>