com.amazonaws.services.ecs.model

Class TaskDefinition

java.lang.Object

com.amazonaws.services.ecs.model.TaskDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TaskDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo

Details of a task definition.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskDefinition()

Method Summary

Modifier and Type	Method and Description
TaskDefinition	clone()
boolean	equals(Object obj)
List<ContainerDefinition>	getContainerDefinitions() A list of container definitions in JSON format that describe the different containers that make up your task.
String	getFamily() The family of your task definition, used as the definition name.
String	getNetworkMode() The Docker networking mode to use for the containers in the task.
List<TaskDefinitionPlacementConstraint>	getPlacementConstraints() An array of placement constraint objects to use for tasks.
List<Attribute>	getRequiresAttributes() The container instance attributes required by your task.
Integer	getRevision() The revision of the task in a particular family.
String	getStatus() The status of the task definition.
String	getTaskDefinitionArn() The full Amazon Resource Name (ARN) of the task definition.
String	getTaskRoleArn() The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
List<Volume>	getVolumes() The list of volumes in a task.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
void	setFamily(String family) The family of your task definition, used as the definition name.
void	setNetworkMode(NetworkMode networkMode) The Docker networking mode to use for the containers in the task.
void	setNetworkMode(String networkMode) The Docker networking mode to use for the containers in the task.
void	setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints) An array of placement constraint objects to use for tasks.
void	setRequiresAttributes(Collection<Attribute> requiresAttributes) The container instance attributes required by your task.
void	setRevision(Integer revision) The revision of the task in a particular family.
void	setStatus(String status) The status of the task definition.
void	setStatus(TaskDefinitionStatus status) The status of the task definition.
void	setTaskDefinitionArn(String taskDefinitionArn) The full Amazon Resource Name (ARN) of the task definition.
void	setTaskRoleArn(String taskRoleArn) The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
void	setVolumes(Collection<Volume> volumes) The list of volumes in a task.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TaskDefinition	withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
TaskDefinition	withContainerDefinitions(ContainerDefinition... containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
TaskDefinition	withFamily(String family) The family of your task definition, used as the definition name.
TaskDefinition	withNetworkMode(NetworkMode networkMode) The Docker networking mode to use for the containers in the task.
TaskDefinition	withNetworkMode(String networkMode) The Docker networking mode to use for the containers in the task.
TaskDefinition	withPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints) An array of placement constraint objects to use for tasks.
TaskDefinition	withPlacementConstraints(TaskDefinitionPlacementConstraint... placementConstraints) An array of placement constraint objects to use for tasks.
TaskDefinition	withRequiresAttributes(Attribute... requiresAttributes) The container instance attributes required by your task.
TaskDefinition	withRequiresAttributes(Collection<Attribute> requiresAttributes) The container instance attributes required by your task.
TaskDefinition	withRevision(Integer revision) The revision of the task in a particular family.
TaskDefinition	withStatus(String status) The status of the task definition.
TaskDefinition	withStatus(TaskDefinitionStatus status) The status of the task definition.
TaskDefinition	withTaskDefinitionArn(String taskDefinitionArn) The full Amazon Resource Name (ARN) of the task definition.
TaskDefinition	withTaskRoleArn(String taskRoleArn) The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
TaskDefinition	withVolumes(Collection<Volume> volumes) The list of volumes in a task.
TaskDefinition	withVolumes(Volume... volumes) The list of volumes in a task.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskDefinition

public TaskDefinition()

Method Detail

setTaskDefinitionArn

public void setTaskDefinitionArn(String taskDefinitionArn)

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

Parameters:

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

getTaskDefinitionArn

public String getTaskDefinitionArn()

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

Returns:

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

withTaskDefinitionArn

public TaskDefinition withTaskDefinitionArn(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.

getContainerDefinitions

public List<ContainerDefinition> getContainerDefinitions()

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.

setContainerDefinitions

public void setContainerDefinitions(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.

withContainerDefinitions

public TaskDefinition withContainerDefinitions(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.

withContainerDefinitions

public TaskDefinition withContainerDefinitions(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.

setFamily

public void setFamily(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.

getFamily

public String getFamily()

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

Returns:

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

withFamily

public TaskDefinition withFamily(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.

setTaskRoleArn

public void setTaskRoleArn(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.

getTaskRoleArn

public String getTaskRoleArn()

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.

withTaskRoleArn

public TaskDefinition withTaskRoleArn(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.

setNetworkMode

public void setNetworkMode(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.

See Also:

NetworkMode

getNetworkMode

public String getNetworkMode()

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

withNetworkMode

public TaskDefinition withNetworkMode(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

setNetworkMode

public void setNetworkMode(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.

See Also:

NetworkMode

withNetworkMode

public TaskDefinition withNetworkMode(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

setRevision

public void setRevision(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).

getRevision

public Integer getRevision()

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

withRevision

public TaskDefinition withRevision(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.

getVolumes

public List<Volume> getVolumes()

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.

setVolumes

public void setVolumes(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.

withVolumes

public TaskDefinition withVolumes(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.

withVolumes

public TaskDefinition withVolumes(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.

setStatus

public void setStatus(String status)

The status of the task definition.

Parameters:

status - The status of the task definition.

See Also:

TaskDefinitionStatus

getStatus

public String getStatus()

The status of the task definition.

Returns:

The status of the task definition.

See Also:

TaskDefinitionStatus

withStatus

public TaskDefinition withStatus(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

setStatus

public void setStatus(TaskDefinitionStatus status)

The status of the task definition.

Parameters:

status - The status of the task definition.

See Also:

TaskDefinitionStatus

withStatus

public TaskDefinition withStatus(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

getRequiresAttributes

public List<Attribute> getRequiresAttributes()

The container instance attributes required by your task.

Returns:

The container instance attributes required by your task.

setRequiresAttributes

public void setRequiresAttributes(Collection<Attribute> requiresAttributes)

The container instance attributes required by your task.

Parameters:

requiresAttributes - The container instance attributes required by your task.

withRequiresAttributes

public TaskDefinition withRequiresAttributes(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.

withRequiresAttributes

public TaskDefinition withRequiresAttributes(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.

getPlacementConstraints

public List<TaskDefinitionPlacementConstraint> getPlacementConstraints()

An array of placement constraint objects to use for tasks.

Returns:

An array of placement constraint objects to use for tasks.

setPlacementConstraints

public void setPlacementConstraints(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.

withPlacementConstraints

public TaskDefinition withPlacementConstraints(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.

withPlacementConstraints

public TaskDefinition withPlacementConstraints(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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public TaskDefinition clone()

Overrides:

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