Package software.amazon.awscdk.services.ecs

Class ExternalTaskDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.ExternalTaskDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ExternalTaskDefinitionProps>

Enclosing interface:

ExternalTaskDefinitionProps

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

A builder for ExternalTaskDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExternalTaskDefinitionProps	build()	Builds the configured instance.
ExternalTaskDefinitionProps.Builder	enableFaultInjection(Boolean enableFaultInjection)	Sets the value of CommonTaskDefinitionProps.getEnableFaultInjection()
ExternalTaskDefinitionProps.Builder	executionRole(IRole executionRole)	Sets the value of CommonTaskDefinitionProps.getExecutionRole()
ExternalTaskDefinitionProps.Builder	family(String family)	Sets the value of CommonTaskDefinitionProps.getFamily()
ExternalTaskDefinitionProps.Builder	networkMode(NetworkMode networkMode)	Sets the value of ExternalTaskDefinitionProps.getNetworkMode()
ExternalTaskDefinitionProps.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration)	Sets the value of CommonTaskDefinitionProps.getProxyConfiguration()
ExternalTaskDefinitionProps.Builder	taskRole(IRole taskRole)	Sets the value of CommonTaskDefinitionProps.getTaskRole()
ExternalTaskDefinitionProps.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

networkMode

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

Sets the value of ExternalTaskDefinitionProps.getNetworkMode()

Parameters:

networkMode - The networking mode to use for the containers in the task. With ECS Anywhere, supported modes are bridge, host and none.

Returns:

this

enableFaultInjection

@Stability(Stable)
public ExternalTaskDefinitionProps.Builder enableFaultInjection(Boolean enableFaultInjection)

Sets the value of CommonTaskDefinitionProps.getEnableFaultInjection()

Parameters:

enableFaultInjection - Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Fault injection only works with tasks using the

invalid @link

NetworkMode.AWS_VPC

or

invalid @link

NetworkMode.HOST

network modes.

Returns:

this

executionRole

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ExternalTaskDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided