Class TaskDefinition
- All Implemented Interfaces:
Serializable
,Cloneable
Details of a task definition.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
A list of container definitions in JSON format that describe the different containers that make up your task.The family of your task definition, used as the definition name.The container instance attributes required by your task.The revision of the task in a particular family.The status of the task definition.The full Amazon Resource Name (ARN) of the task definition.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
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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withContainerDefinitions
(ContainerDefinition... containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.withContainerDefinitions
(Collection<ContainerDefinition> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.withFamily
(String family) The family of your task definition, used as the definition name.withRequiresAttributes
(Attribute... requiresAttributes) The container instance attributes required by your task.withRequiresAttributes
(Collection<Attribute> requiresAttributes) The container instance attributes required by your task.withRevision
(Integer revision) The revision of the task in a particular family.withStatus
(TaskDefinitionStatus status) The status of the task definition.withStatus
(String status) The status of the task definition.withTaskDefinitionArn
(String taskDefinitionArn) The full Amazon Resource Name (ARN) of the task definition.withVolumes
(Volume... volumes) The list of volumes in a task.withVolumes
(Collection<Volume> volumes) The list of volumes in a task.
-
Constructor Details
-
TaskDefinition
public TaskDefinition()
-
-
Method Details
-
setTaskDefinitionArn
The full Amazon Resource Name (ARN) of the task definition.
- Parameters:
taskDefinitionArn
- The full Amazon Resource Name (ARN) of the task definition.
-
getTaskDefinitionArn
The full Amazon Resource Name (ARN) of the task definition.
- Returns:
- The full Amazon Resource Name (ARN) of the task definition.
-
withTaskDefinitionArn
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
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
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
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
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
The family of your task definition, used as the definition name.
- Returns:
- The family of your task definition, used as the definition name.
-
withFamily
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
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
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
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
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
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
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
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
The status of the task definition.
- Parameters:
status
- The status of the task definition.- See Also:
-
getStatus
The status of the task definition.
- Returns:
- The status of the task definition.
- See Also:
-
withStatus
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:
-
setStatus
The status of the task definition.
- Parameters:
status
- The status of the task definition.- See Also:
-
withStatus
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:
-
getRequiresAttributes
The container instance attributes required by your task.
- Returns:
- The container instance attributes required by your task.
-
setRequiresAttributes
The container instance attributes required by your task.
- Parameters:
requiresAttributes
- The container instance attributes required by your task.
-
withRequiresAttributes
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-