software.amazon.awscdk.services.ecs

Class FargateTaskDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.FargateTaskDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateTaskDefinitionProps>

Enclosing interface:

FargateTaskDefinitionProps

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

A builder for FargateTaskDefinitionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FargateTaskDefinitionProps	build() Builds the configured instance.
FargateTaskDefinitionProps.Builder	cpu(Number cpu) Sets the value of FargateTaskDefinitionProps.getCpu()
FargateTaskDefinitionProps.Builder	executionRole(IRole executionRole) Sets the value of CommonTaskDefinitionProps.getExecutionRole()
FargateTaskDefinitionProps.Builder	family(String family) Sets the value of CommonTaskDefinitionProps.getFamily()
FargateTaskDefinitionProps.Builder	memoryLimitMiB(Number memoryLimitMiB) Sets the value of FargateTaskDefinitionProps.getMemoryLimitMiB()
FargateTaskDefinitionProps.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration) Sets the value of CommonTaskDefinitionProps.getProxyConfiguration()
FargateTaskDefinitionProps.Builder	taskRole(IRole taskRole) Sets the value of CommonTaskDefinitionProps.getTaskRole()
FargateTaskDefinitionProps.Builder	volumes(List<? extends Volume> volumes) Sets the value of CommonTaskDefinitionProps.getVolumes()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cpu

@Stability(value=Stable)
public FargateTaskDefinitionProps.Builder cpu(Number cpu)

Sets the value of FargateTaskDefinitionProps.getCpu()

Parameters:

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)

Returns:

this

memoryLimitMiB

@Stability(value=Stable)
public FargateTaskDefinitionProps.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of FargateTaskDefinitionProps.getMemoryLimitMiB()

Parameters:

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)

Returns:

this

executionRole

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

Sets the value of CommonTaskDefinitionProps.getExecutionRole()

Parameters:

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.

Returns:

this

family

@Stability(value=Stable)
public FargateTaskDefinitionProps.Builder family(String family)

Sets the value of CommonTaskDefinitionProps.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(value=Stable)
public FargateTaskDefinitionProps.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)

Sets the value of CommonTaskDefinitionProps.getProxyConfiguration()

Parameters:

proxyConfiguration - The configuration details for the App Mesh proxy.

Returns:

this

taskRole

@Stability(value=Stable)
public FargateTaskDefinitionProps.Builder taskRole(IRole taskRole)

Sets the value of CommonTaskDefinitionProps.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

@Stability(value=Stable)
public FargateTaskDefinitionProps.Builder volumes(List<? extends Volume> volumes)

Sets the value of CommonTaskDefinitionProps.getVolumes()

Parameters:

volumes - The list of volume definitions for the task. For more information, see Task Definition Parameter Volumes.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of FargateTaskDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided