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

Interface RegisterTaskDefinitionRequest.Builder

All Superinterfaces:

CopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>, SdkBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>

Enclosing class:

RegisterTaskDefinitionRequest

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

Method Summary

Modifier and Type	Method	Description
RegisterTaskDefinitionRequest.Builder	containerDefinitions(Collection<ContainerDefinition> containerDefinitions)	A list of container definitions in JSON format that describe the different containers that make up your task.
RegisterTaskDefinitionRequest.Builder	containerDefinitions(ContainerDefinition... containerDefinitions)	A list of container definitions in JSON format that describe the different containers that make up your task.
RegisterTaskDefinitionRequest.Builder	family(String family)	You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
RegisterTaskDefinitionRequest.Builder	networkMode(String networkMode)	The Docker networking mode to use for the containers in the task.
RegisterTaskDefinitionRequest.Builder	networkMode(NetworkMode networkMode)	The Docker networking mode to use for the containers in the task.
RegisterTaskDefinitionRequest.Builder	placementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)	An array of placement constraint objects to use for the task.
RegisterTaskDefinitionRequest.Builder	placementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)	An array of placement constraint objects to use for the task.
RegisterTaskDefinitionRequest.Builder	taskRoleArn(String taskRoleArn)	The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
RegisterTaskDefinitionRequest.Builder	volumes(Collection<Volume> volumes)	A list of volume definitions in JSON format that containers in your task may use.
RegisterTaskDefinitionRequest.Builder	volumes(Volume... volumes)	A list of volume definitions in JSON format that containers in your task may use.

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

family

RegisterTaskDefinitionRequest.Builder family(String family)

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Parameters:

family - You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

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

taskRoleArn

RegisterTaskDefinitionRequest.Builder taskRoleArn(String taskRoleArn)

The short name or full 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. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

Parameters:

taskRoleArn - The short name or full 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. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

Returns:

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

networkMode

RegisterTaskDefinitionRequest.Builder networkMode(String networkMode)

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

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

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.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

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

RegisterTaskDefinitionRequest.Builder networkMode(NetworkMode networkMode)

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

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

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.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

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

containerDefinitions

RegisterTaskDefinitionRequest.Builder containerDefinitions(Collection<ContainerDefinition> containerDefinitions)

A list of container definitions in JSON format that describe the different containers that make up your task.

Parameters:

containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task.

Returns:

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

containerDefinitions

RegisterTaskDefinitionRequest.Builder containerDefinitions(ContainerDefinition... containerDefinitions)

A list of container definitions in JSON format that describe the different containers that make up your task.

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.

Returns:

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

volumes

RegisterTaskDefinitionRequest.Builder volumes(Collection<Volume> volumes)

A list of volume definitions in JSON format that containers in your task may use.

Parameters:

volumes - A list of volume definitions in JSON format that containers in your task may use.

Returns:

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

volumes

RegisterTaskDefinitionRequest.Builder volumes(Volume... volumes)

A list of volume definitions in JSON format that containers in your task may use.

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 - A list of volume definitions in JSON format that containers in your task may use.

Returns:

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

placementConstraints

RegisterTaskDefinitionRequest.Builder placementConstraints(Collection<TaskDefinitionPlacementConstraint> 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).

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:

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

placementConstraints

RegisterTaskDefinitionRequest.Builder placementConstraints(TaskDefinitionPlacementConstraint... 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).

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 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:

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