software.amazon.awscdk.services.ecs

Class Ec2TaskDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.Ec2TaskDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Ec2TaskDefinition>

Enclosing class:

Ec2TaskDefinition

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

(experimental) A fluent builder for Ec2TaskDefinition.

Method Summary

Modifier and Type	Method and Description
Ec2TaskDefinition	build()
static Ec2TaskDefinition.Builder	create(software.constructs.Construct scope, String id)
Ec2TaskDefinition.Builder	executionRole(IRole executionRole) (experimental) The name of the IAM task execution role that grants the ECS agent to call AWS APIs on your behalf.
Ec2TaskDefinition.Builder	family(String family) (experimental) The name of a family that this task definition is registered to.
Ec2TaskDefinition.Builder	inferenceAccelerators(List<? extends InferenceAccelerator> inferenceAccelerators) (experimental) The inference accelerators to use for the containers in the task.
Ec2TaskDefinition.Builder	ipcMode(IpcMode ipcMode) (experimental) The IPC resource namespace to use for the containers in the task.
Ec2TaskDefinition.Builder	networkMode(NetworkMode networkMode) (experimental) The Docker networking mode to use for the containers in the task.
Ec2TaskDefinition.Builder	pidMode(PidMode pidMode) (experimental) The process namespace to use for the containers in the task.
Ec2TaskDefinition.Builder	placementConstraints(List<? extends PlacementConstraint> placementConstraints) (experimental) An array of placement constraint objects to use for the task.
Ec2TaskDefinition.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration) (experimental) The configuration details for the App Mesh proxy.
Ec2TaskDefinition.Builder	taskRole(IRole taskRole) (experimental) The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
Ec2TaskDefinition.Builder	volumes(List<? extends Volume> volumes) (experimental) 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=Experimental)
public static Ec2TaskDefinition.Builder create(software.constructs.Construct scope,
                                                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Ec2TaskDefinition.Builder.

executionRole

@Stability(value=Experimental)
public Ec2TaskDefinition.Builder executionRole(IRole executionRole)

(experimental) 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=Experimental)
public Ec2TaskDefinition.Builder family(String family)

(experimental) 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=Experimental)
public Ec2TaskDefinition.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)

(experimental) 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=Experimental)
public Ec2TaskDefinition.Builder taskRole(IRole taskRole)

(experimental) 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=Experimental)
public Ec2TaskDefinition.Builder volumes(List<? extends Volume> volumes)

(experimental) 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

inferenceAccelerators

@Stability(value=Experimental)
public Ec2TaskDefinition.Builder inferenceAccelerators(List<? extends InferenceAccelerator> inferenceAccelerators)

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

Not supported in Fargate.

Default: - No inference accelerators.

Parameters:

inferenceAccelerators - The inference accelerators to use for the containers in the task. This parameter is required.

Returns:

this

ipcMode

@Stability(value=Experimental)
public Ec2TaskDefinition.Builder ipcMode(IpcMode ipcMode)

(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

Parameters:

ipcMode - The IPC resource namespace to use for the containers in the task. This parameter is required.

Returns:

this

networkMode

@Stability(value=Experimental)
public Ec2TaskDefinition.Builder networkMode(NetworkMode networkMode)

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

The valid values are none, bridge, awsvpc, and host.

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

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. This parameter is required.

Returns:

this

pidMode

@Stability(value=Experimental)
public Ec2TaskDefinition.Builder pidMode(PidMode pidMode)

(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

Parameters:

pidMode - The process namespace to use for the containers in the task. This parameter is required.

Returns:

this

placementConstraints

@Stability(value=Experimental)
public Ec2TaskDefinition.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints)

(experimental) An array of placement constraint objects to use for the task.

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

Default: - No placement constraints.

Parameters:

placementConstraints - An array of placement constraint objects to use for the task. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Ec2TaskDefinition build()

Specified by:

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