Package software.amazon.awscdk.services.ecs

Class Ec2TaskDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.Ec2TaskDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Ec2TaskDefinitionProps>

Enclosing interface:

Ec2TaskDefinitionProps

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

A builder for Ec2TaskDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Ec2TaskDefinitionProps	build()	Builds the configured instance.
Ec2TaskDefinitionProps.Builder	executionRole(IRole executionRole)	Sets the value of CommonTaskDefinitionProps.getExecutionRole()
Ec2TaskDefinitionProps.Builder	family(String family)	Sets the value of CommonTaskDefinitionProps.getFamily()
Ec2TaskDefinitionProps.Builder	inferenceAccelerators(List<? extends InferenceAccelerator> inferenceAccelerators)	Sets the value of Ec2TaskDefinitionProps.getInferenceAccelerators()
Ec2TaskDefinitionProps.Builder	ipcMode(IpcMode ipcMode)	Sets the value of Ec2TaskDefinitionProps.getIpcMode()
Ec2TaskDefinitionProps.Builder	networkMode(NetworkMode networkMode)	Sets the value of Ec2TaskDefinitionProps.getNetworkMode()
Ec2TaskDefinitionProps.Builder	pidMode(PidMode pidMode)	Sets the value of Ec2TaskDefinitionProps.getPidMode()
Ec2TaskDefinitionProps.Builder	placementConstraints(List<? extends PlacementConstraint> placementConstraints)	Sets the value of Ec2TaskDefinitionProps.getPlacementConstraints()
Ec2TaskDefinitionProps.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration)	Sets the value of CommonTaskDefinitionProps.getProxyConfiguration()
Ec2TaskDefinitionProps.Builder	taskRole(IRole taskRole)	Sets the value of CommonTaskDefinitionProps.getTaskRole()
Ec2TaskDefinitionProps.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 Details

Builder

public Builder()

Method Details

inferenceAccelerators

@Stability(Stable)
public Ec2TaskDefinitionProps.Builder inferenceAccelerators(List<? extends InferenceAccelerator> inferenceAccelerators)

Sets the value of Ec2TaskDefinitionProps.getInferenceAccelerators()

Parameters:

inferenceAccelerators - The inference accelerators to use for the containers in the task. Not supported in Fargate.

Returns:

this

ipcMode

@Stability(Stable)
public Ec2TaskDefinitionProps.Builder ipcMode(IpcMode ipcMode)

Sets the value of Ec2TaskDefinitionProps.getIpcMode()

Parameters:

ipcMode - The IPC resource namespace to use for the containers in the task. Not supported in Fargate and Windows containers.

Returns:

this

networkMode

@Stability(Stable)
public Ec2TaskDefinitionProps.Builder networkMode(NetworkMode networkMode)

Sets the value of Ec2TaskDefinitionProps.getNetworkMode()

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. The valid values are NONE, BRIDGE, AWS_VPC, and HOST.

Returns:

this

pidMode

@Stability(Stable)
public Ec2TaskDefinitionProps.Builder pidMode(PidMode pidMode)

Sets the value of Ec2TaskDefinitionProps.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 Ec2TaskDefinitionProps.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints)

Sets the value of Ec2TaskDefinitionProps.getPlacementConstraints()

Parameters:

placementConstraints - 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).

Returns:

this

executionRole

@Stability(Stable)
public Ec2TaskDefinitionProps.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 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

@Stability(Stable)
public Ec2TaskDefinitionProps.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(Stable)
public Ec2TaskDefinitionProps.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)

Sets the value of CommonTaskDefinitionProps.getProxyConfiguration()

Parameters:

proxyConfiguration - The configuration details for the App Mesh proxy.

Returns:

this

taskRole

@Stability(Stable)
public Ec2TaskDefinitionProps.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(Stable)
public Ec2TaskDefinitionProps.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(Stable)
public Ec2TaskDefinitionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of Ec2TaskDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided