software.amazon.awscdk.services.ecs

Class ExternalTaskDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.ExternalTaskDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ExternalTaskDefinition>

Enclosing class:

ExternalTaskDefinition

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

A fluent builder for ExternalTaskDefinition.

Method Summary

Modifier and Type	Method and Description
ExternalTaskDefinition	build()
static ExternalTaskDefinition.Builder	create(software.constructs.Construct scope, String id)
ExternalTaskDefinition.Builder	executionRole(IRole executionRole) The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf.
ExternalTaskDefinition.Builder	family(String family) The name of a family that this task definition is registered to.
ExternalTaskDefinition.Builder	networkMode(NetworkMode networkMode) The networking mode to use for the containers in the task.
ExternalTaskDefinition.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration) The configuration details for the App Mesh proxy.
ExternalTaskDefinition.Builder	taskRole(IRole taskRole) The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
ExternalTaskDefinition.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 ExternalTaskDefinition.Builder create(software.constructs.Construct scope,
                                                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ExternalTaskDefinition.Builder.

executionRole

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

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 permission to call AWS APIs on your behalf. This parameter is required.

Returns:

this

family

@Stability(value=Stable)
public ExternalTaskDefinition.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 ExternalTaskDefinition.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 ExternalTaskDefinition.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 ExternalTaskDefinition.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

networkMode

@Stability(value=Stable)
public ExternalTaskDefinition.Builder networkMode(NetworkMode networkMode)

The networking mode to use for the containers in the task.

With ECS Anywhere, supported modes are bridge, host and none.

Default: NetworkMode.BRIDGE

Parameters:

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

Returns:

this

build

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

Specified by:

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