Package software.amazon.awssdk.services.ecs.model

Interface TaskDefinition.Builder

All Superinterfaces:

CopyableBuilder<TaskDefinition.Builder,TaskDefinition>, SdkBuilder<TaskDefinition.Builder,TaskDefinition>

Enclosing class:

TaskDefinition

public static interface TaskDefinition.Builder
extends CopyableBuilder<TaskDefinition.Builder,TaskDefinition>

Method Summary

Modifier and Type	Method	Description
TaskDefinition.Builder	containerDefinitions(Collection<ContainerDefinition> containerDefinitions)	A list of container definitions in JSON format that describe the different containers that make up your task.
TaskDefinition.Builder	containerDefinitions(ContainerDefinition... containerDefinitions)	A list of container definitions in JSON format that describe the different containers that make up your task.
TaskDefinition.Builder	family(String family)	The family of your task definition, used as the definition name.
TaskDefinition.Builder	networkMode(String networkMode)	The Docker networking mode to use for the containers in the task.
TaskDefinition.Builder	networkMode(NetworkMode networkMode)	The Docker networking mode to use for the containers in the task.
TaskDefinition.Builder	placementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)	An array of placement constraint objects to use for tasks.
TaskDefinition.Builder	placementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)	An array of placement constraint objects to use for tasks.
TaskDefinition.Builder	requiresAttributes(Collection<Attribute> requiresAttributes)	The container instance attributes required by your task.
TaskDefinition.Builder	requiresAttributes(Attribute... requiresAttributes)	The container instance attributes required by your task.
TaskDefinition.Builder	revision(Integer revision)	The revision of the task in a particular family.
TaskDefinition.Builder	status(String status)	The status of the task definition.
TaskDefinition.Builder	status(TaskDefinitionStatus status)	The status of the task definition.
TaskDefinition.Builder	taskDefinitionArn(String taskDefinitionArn)	The full Amazon Resource Name (ARN) of the task definition.
TaskDefinition.Builder	taskRoleArn(String taskRoleArn)	The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
TaskDefinition.Builder	volumes(Collection<Volume> volumes)	The list of volumes in a task.
TaskDefinition.Builder	volumes(Volume... volumes)	The list of volumes in a task.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

taskDefinitionArn

TaskDefinition.Builder taskDefinitionArn(String taskDefinitionArn)

The full Amazon Resource Name (ARN) of the task definition.

Parameters:

taskDefinitionArn - The full Amazon Resource Name (ARN) of the task definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

containerDefinitions

TaskDefinition.Builder containerDefinitions(Collection<ContainerDefinition> containerDefinitions)

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

Parameters:

containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

containerDefinitions

TaskDefinition.Builder containerDefinitions(ContainerDefinition... containerDefinitions)

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use #setContainerDefinitions(java.util.Collection) or #withContainerDefinitions(java.util.Collection) if you want to override the existing values.

Parameters:

containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

family

TaskDefinition.Builder family(String family)

The family of your task definition, used as the definition name.

Parameters:

family - The family of your task definition, used as the definition name.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskRoleArn

TaskDefinition.Builder taskRoleArn(String taskRoleArn)

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

Parameters:

taskRoleArn - The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkMode

TaskDefinition.Builder networkMode(String networkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode.

For more information, see Network settings in the Docker run reference.

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode.

For more information, see Network settings in the Docker run reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NetworkMode

networkMode

TaskDefinition.Builder networkMode(NetworkMode networkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode.

For more information, see Network settings in the Docker run reference.

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode.

For more information, see Network settings in the Docker run reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NetworkMode

revision

TaskDefinition.Builder revision(Integer revision)

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).

Parameters:

revision - The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).

Returns:

Returns a reference to this object so that method calls can be chained together.

volumes

TaskDefinition.Builder volumes(Collection<Volume> volumes)

The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

Parameters:

volumes - The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

volumes

TaskDefinition.Builder volumes(Volume... volumes)

The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use #setVolumes(java.util.Collection) or #withVolumes(java.util.Collection) if you want to override the existing values.

Parameters:

volumes - The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

TaskDefinition.Builder status(String status)

The status of the task definition.

Parameters:

status - The status of the task definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskDefinitionStatus

status

TaskDefinition.Builder status(TaskDefinitionStatus status)

The status of the task definition.

Parameters:

status - The status of the task definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskDefinitionStatus

requiresAttributes

TaskDefinition.Builder requiresAttributes(Collection<Attribute> requiresAttributes)

The container instance attributes required by your task.

Parameters:

requiresAttributes - The container instance attributes required by your task.

Returns:

Returns a reference to this object so that method calls can be chained together.

requiresAttributes

TaskDefinition.Builder requiresAttributes(Attribute... requiresAttributes)

The container instance attributes required by your task.

NOTE: This method appends the values to the existing list (if any). Use #setRequiresAttributes(java.util.Collection) or #withRequiresAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

requiresAttributes - The container instance attributes required by your task.

Returns:

Returns a reference to this object so that method calls can be chained together.

placementConstraints

TaskDefinition.Builder placementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)

An array of placement constraint objects to use for tasks.

Parameters:

placementConstraints - An array of placement constraint objects to use for tasks.

Returns:

Returns a reference to this object so that method calls can be chained together.

placementConstraints

TaskDefinition.Builder placementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)

An array of placement constraint objects to use for tasks.

NOTE: This method appends the values to the existing list (if any). Use #setPlacementConstraints(java.util.Collection) or #withPlacementConstraints(java.util.Collection) if you want to override the existing values.

Parameters:

placementConstraints - An array of placement constraint objects to use for tasks.

Returns:

Returns a reference to this object so that method calls can be chained together.