Class TaskDefinition
- java.lang.Object
-
- com.amazonaws.services.ecs.model.TaskDefinition
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class TaskDefinition extends Object implements Serializable, Cloneable
Details of a task definition.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TaskDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.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.List<Volume>
getVolumes()
The list of volumes in a task.int
hashCode()
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
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(TaskDefinitionStatus status)
The status of the task definition.void
setStatus(String status)
The status of the task definition.void
setTaskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.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(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.TaskDefinition
withContainerDefinitions(Collection<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
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(TaskDefinitionStatus status)
The status of the task definition.TaskDefinition
withStatus(String status)
The status of the task definition.TaskDefinition
withTaskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.TaskDefinition
withVolumes(Volume... volumes)
The list of volumes in a task.TaskDefinition
withVolumes(Collection<Volume> volumes)
The list of volumes in a task.
-
-
-
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)
orwithContainerDefinitions(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.
-
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 is1
; 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 is1
; 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)
orwithVolumes(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)
orwithRequiresAttributes(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.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public TaskDefinition clone()
-
-