Package software.amazon.awscdk.services.ecs

Class TaskDefinitionAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.TaskDefinitionAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TaskDefinitionAttributes>

Enclosing interface:

TaskDefinitionAttributes

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

A builder for TaskDefinitionAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TaskDefinitionAttributes	build()	Builds the configured instance.
TaskDefinitionAttributes.Builder	compatibility(Compatibility compatibility)	Sets the value of TaskDefinitionAttributes.getCompatibility()
TaskDefinitionAttributes.Builder	executionRole(IRole executionRole)	Sets the value of CommonTaskDefinitionAttributes.getExecutionRole()
TaskDefinitionAttributes.Builder	networkMode(NetworkMode networkMode)	Sets the value of CommonTaskDefinitionAttributes.getNetworkMode()
TaskDefinitionAttributes.Builder	taskDefinitionArn(String taskDefinitionArn)	Sets the value of CommonTaskDefinitionAttributes.getTaskDefinitionArn()
TaskDefinitionAttributes.Builder	taskRole(IRole taskRole)	Sets the value of CommonTaskDefinitionAttributes.getTaskRole()

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

compatibility

@Stability(Stable)
public TaskDefinitionAttributes.Builder compatibility(Compatibility compatibility)

Sets the value of TaskDefinitionAttributes.getCompatibility()

Parameters:

compatibility - What launch types this task definition should be compatible with.

Returns:

this

taskDefinitionArn

@Stability(Stable)
public TaskDefinitionAttributes.Builder taskDefinitionArn(String taskDefinitionArn)

Sets the value of CommonTaskDefinitionAttributes.getTaskDefinitionArn()

Parameters:

taskDefinitionArn - The arn of the task definition. This parameter is required.

Returns:

this

executionRole

@Stability(Stable)
public TaskDefinitionAttributes.Builder executionRole(IRole executionRole)

Sets the value of CommonTaskDefinitionAttributes.getExecutionRole()

Parameters:

executionRole - The IAM role that grants containers and Fargate agents permission to make AWS API calls on your behalf. Some tasks do not have an execution role.

Returns:

this

networkMode

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

Sets the value of CommonTaskDefinitionAttributes.getNetworkMode()

Parameters:

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

Returns:

this

taskRole

@Stability(Stable)
public TaskDefinitionAttributes.Builder taskRole(IRole taskRole)

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

build

@Stability(Stable)
public TaskDefinitionAttributes build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TaskDefinitionAttributes

Throws:

NullPointerException - if any required attribute was not provided