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

Class TaskDefinition

java.lang.Object

software.amazon.awssdk.services.ecs.model.TaskDefinition

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>

@Generated("software.amazon.awssdk:codegen")
public class TaskDefinition
extends Object
implements StructuredPojo, ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>

Details of a task definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TaskDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static TaskDefinition.Builder	builder()
List<ContainerDefinition>	containerDefinitions()	A list of container definitions in JSON format that describe the different containers that make up your task.
boolean	equals(Object obj)
String	family()	The family of your task definition, used as the definition name.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	networkMode()	The Docker networking mode to use for the containers in the task.
List<TaskDefinitionPlacementConstraint>	placementConstraints()	An array of placement constraint objects to use for tasks.
List<Attribute>	requiresAttributes()	The container instance attributes required by your task.
Integer	revision()	The revision of the task in a particular family.
static Class<? extends TaskDefinition.Builder>	serializableBuilderClass()
String	status()	The status of the task definition.
String	taskDefinitionArn()	The full Amazon Resource Name (ARN) of the task definition.
String	taskRoleArn()	The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
TaskDefinition.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<Volume>	volumes()	The list of volumes in a task.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

taskDefinitionArn

public String taskDefinitionArn()

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

Returns:

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

containerDefinitions

public List<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.

Returns:

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.

family

public String family()

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

Returns:

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

taskRoleArn

public 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.

Returns:

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.

networkMode

public 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.

Returns:

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.

See Also:

NetworkMode

revision

public 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).

Returns:

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).

volumes

public List<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.

Returns:

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.

status

public String status()

The status of the task definition.

Returns:

The status of the task definition.

See Also:

TaskDefinitionStatus

requiresAttributes

public List<Attribute> requiresAttributes()

The container instance attributes required by your task.

Returns:

The container instance attributes required by your task.

placementConstraints

public List<TaskDefinitionPlacementConstraint> placementConstraints()

An array of placement constraint objects to use for tasks.

Returns:

An array of placement constraint objects to use for tasks.

toBuilder

public TaskDefinition.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>

Returns:

a builder for type T

builder

public static TaskDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends TaskDefinition.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.