@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AwsEcsTaskDefinitionDetails extends Object implements Serializable, Cloneable, StructuredPojo
Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.
Constructor and Description |
---|
AwsEcsTaskDefinitionDetails() |
Modifier and Type | Method and Description |
---|---|
AwsEcsTaskDefinitionDetails |
clone() |
boolean |
equals(Object obj) |
List<AwsEcsTaskDefinitionContainerDefinitionsDetails> |
getContainerDefinitions()
The container definitions that describe the containers that make up the task.
|
String |
getCpu()
The number of CPU units used by the task.Valid values are as follows:
|
String |
getExecutionRoleArn()
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the
container user.
|
String |
getFamily()
The name of a family that this task definition is registered to.
|
List<AwsEcsTaskDefinitionInferenceAcceleratorsDetails> |
getInferenceAccelerators()
The Elastic Inference accelerators to use for the containers in the task.
|
String |
getIpcMode()
The inter-process communication (IPC) resource namespace to use for the containers in the task.
|
String |
getMemory()
The amount (in MiB) of memory used by the task.
|
String |
getNetworkMode()
The Docker networking mode to use for the containers in the task.
|
String |
getPidMode()
The process namespace to use for the containers in the task.
|
List<AwsEcsTaskDefinitionPlacementConstraintsDetails> |
getPlacementConstraints()
The placement constraint objects to use for tasks.
|
AwsEcsTaskDefinitionProxyConfigurationDetails |
getProxyConfiguration()
The configuration details for the App Mesh proxy.
|
List<String> |
getRequiresCompatibilities()
The task launch types that the task definition was validated against.
|
String |
getStatus()
The status of the task definition.
|
String |
getTaskRoleArn()
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services
API operations on your behalf.
|
List<AwsEcsTaskDefinitionVolumesDetails> |
getVolumes()
The data volume definitions for the task.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setContainerDefinitions(Collection<AwsEcsTaskDefinitionContainerDefinitionsDetails> containerDefinitions)
The container definitions that describe the containers that make up the task.
|
void |
setCpu(String cpu)
The number of CPU units used by the task.Valid values are as follows:
|
void |
setExecutionRoleArn(String executionRoleArn)
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the
container user.
|
void |
setFamily(String family)
The name of a family that this task definition is registered to.
|
void |
setInferenceAccelerators(Collection<AwsEcsTaskDefinitionInferenceAcceleratorsDetails> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
|
void |
setIpcMode(String ipcMode)
The inter-process communication (IPC) resource namespace to use for the containers in the task.
|
void |
setMemory(String memory)
The amount (in MiB) of memory used by the task.
|
void |
setNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
void |
setPidMode(String pidMode)
The process namespace to use for the containers in the task.
|
void |
setPlacementConstraints(Collection<AwsEcsTaskDefinitionPlacementConstraintsDetails> placementConstraints)
The placement constraint objects to use for tasks.
|
void |
setProxyConfiguration(AwsEcsTaskDefinitionProxyConfigurationDetails proxyConfiguration)
The configuration details for the App Mesh proxy.
|
void |
setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types that the task definition was validated against.
|
void |
setStatus(String status)
The status of the task definition.
|
void |
setTaskRoleArn(String taskRoleArn)
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services
API operations on your behalf.
|
void |
setVolumes(Collection<AwsEcsTaskDefinitionVolumesDetails> volumes)
The data volume definitions for the task.
|
String |
toString()
Returns a string representation of this object.
|
AwsEcsTaskDefinitionDetails |
withContainerDefinitions(AwsEcsTaskDefinitionContainerDefinitionsDetails... containerDefinitions)
The container definitions that describe the containers that make up the task.
|
AwsEcsTaskDefinitionDetails |
withContainerDefinitions(Collection<AwsEcsTaskDefinitionContainerDefinitionsDetails> containerDefinitions)
The container definitions that describe the containers that make up the task.
|
AwsEcsTaskDefinitionDetails |
withCpu(String cpu)
The number of CPU units used by the task.Valid values are as follows:
|
AwsEcsTaskDefinitionDetails |
withExecutionRoleArn(String executionRoleArn)
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the
container user.
|
AwsEcsTaskDefinitionDetails |
withFamily(String family)
The name of a family that this task definition is registered to.
|
AwsEcsTaskDefinitionDetails |
withInferenceAccelerators(AwsEcsTaskDefinitionInferenceAcceleratorsDetails... inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
|
AwsEcsTaskDefinitionDetails |
withInferenceAccelerators(Collection<AwsEcsTaskDefinitionInferenceAcceleratorsDetails> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
|
AwsEcsTaskDefinitionDetails |
withIpcMode(String ipcMode)
The inter-process communication (IPC) resource namespace to use for the containers in the task.
|
AwsEcsTaskDefinitionDetails |
withMemory(String memory)
The amount (in MiB) of memory used by the task.
|
AwsEcsTaskDefinitionDetails |
withNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
AwsEcsTaskDefinitionDetails |
withPidMode(String pidMode)
The process namespace to use for the containers in the task.
|
AwsEcsTaskDefinitionDetails |
withPlacementConstraints(AwsEcsTaskDefinitionPlacementConstraintsDetails... placementConstraints)
The placement constraint objects to use for tasks.
|
AwsEcsTaskDefinitionDetails |
withPlacementConstraints(Collection<AwsEcsTaskDefinitionPlacementConstraintsDetails> placementConstraints)
The placement constraint objects to use for tasks.
|
AwsEcsTaskDefinitionDetails |
withProxyConfiguration(AwsEcsTaskDefinitionProxyConfigurationDetails proxyConfiguration)
The configuration details for the App Mesh proxy.
|
AwsEcsTaskDefinitionDetails |
withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types that the task definition was validated against.
|
AwsEcsTaskDefinitionDetails |
withRequiresCompatibilities(String... requiresCompatibilities)
The task launch types that the task definition was validated against.
|
AwsEcsTaskDefinitionDetails |
withStatus(String status)
The status of the task definition.
|
AwsEcsTaskDefinitionDetails |
withTaskRoleArn(String taskRoleArn)
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services
API operations on your behalf.
|
AwsEcsTaskDefinitionDetails |
withVolumes(AwsEcsTaskDefinitionVolumesDetails... volumes)
The data volume definitions for the task.
|
AwsEcsTaskDefinitionDetails |
withVolumes(Collection<AwsEcsTaskDefinitionVolumesDetails> volumes)
The data volume definitions for the task.
|
public List<AwsEcsTaskDefinitionContainerDefinitionsDetails> getContainerDefinitions()
The container definitions that describe the containers that make up the task.
public void setContainerDefinitions(Collection<AwsEcsTaskDefinitionContainerDefinitionsDetails> containerDefinitions)
The container definitions that describe the containers that make up the task.
containerDefinitions
- The container definitions that describe the containers that make up the task.public AwsEcsTaskDefinitionDetails withContainerDefinitions(AwsEcsTaskDefinitionContainerDefinitionsDetails... containerDefinitions)
The container definitions that describe the containers that make up the 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.
containerDefinitions
- The container definitions that describe the containers that make up the task.public AwsEcsTaskDefinitionDetails withContainerDefinitions(Collection<AwsEcsTaskDefinitionContainerDefinitionsDetails> containerDefinitions)
The container definitions that describe the containers that make up the task.
containerDefinitions
- The container definitions that describe the containers that make up the task.public void setCpu(String cpu)
The number of CPU units used by the task.Valid values are as follows:
256 (.25 vCPU)
512 (.5 vCPU)
1024 (1 vCPU)
2048 (2 vCPU)
4096 (4 vCPU)
cpu
- The number of CPU units used by the task.Valid values are as follows:
256 (.25 vCPU)
512 (.5 vCPU)
1024 (1 vCPU)
2048 (2 vCPU)
4096 (4 vCPU)
public String getCpu()
The number of CPU units used by the task.Valid values are as follows:
256 (.25 vCPU)
512 (.5 vCPU)
1024 (1 vCPU)
2048 (2 vCPU)
4096 (4 vCPU)
256 (.25 vCPU)
512 (.5 vCPU)
1024 (1 vCPU)
2048 (2 vCPU)
4096 (4 vCPU)
public AwsEcsTaskDefinitionDetails withCpu(String cpu)
The number of CPU units used by the task.Valid values are as follows:
256 (.25 vCPU)
512 (.5 vCPU)
1024 (1 vCPU)
2048 (2 vCPU)
4096 (4 vCPU)
cpu
- The number of CPU units used by the task.Valid values are as follows:
256 (.25 vCPU)
512 (.5 vCPU)
1024 (1 vCPU)
2048 (2 vCPU)
4096 (4 vCPU)
public void setExecutionRoleArn(String executionRoleArn)
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
executionRoleArn
- The ARN of the task execution role that grants the container agent permission to make API calls on behalf
of the container user.public String getExecutionRoleArn()
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
public AwsEcsTaskDefinitionDetails withExecutionRoleArn(String executionRoleArn)
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
executionRoleArn
- The ARN of the task execution role that grants the container agent permission to make API calls on behalf
of the container user.public void setFamily(String family)
The name of a family that this task definition is registered to.
family
- The name of a family that this task definition is registered to.public String getFamily()
The name of a family that this task definition is registered to.
public AwsEcsTaskDefinitionDetails withFamily(String family)
The name of a family that this task definition is registered to.
family
- The name of a family that this task definition is registered to.public List<AwsEcsTaskDefinitionInferenceAcceleratorsDetails> getInferenceAccelerators()
The Elastic Inference accelerators to use for the containers in the task.
public void setInferenceAccelerators(Collection<AwsEcsTaskDefinitionInferenceAcceleratorsDetails> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task.public AwsEcsTaskDefinitionDetails withInferenceAccelerators(AwsEcsTaskDefinitionInferenceAcceleratorsDetails... inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
NOTE: This method appends the values to the existing list (if any). Use
setInferenceAccelerators(java.util.Collection)
or
withInferenceAccelerators(java.util.Collection)
if you want to override the existing values.
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task.public AwsEcsTaskDefinitionDetails withInferenceAccelerators(Collection<AwsEcsTaskDefinitionInferenceAcceleratorsDetails> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task.public void setIpcMode(String ipcMode)
The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:
host
none
task
ipcMode
- The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid
values are as follows:
host
none
task
public String getIpcMode()
The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:
host
none
task
host
none
task
public AwsEcsTaskDefinitionDetails withIpcMode(String ipcMode)
The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:
host
none
task
ipcMode
- The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid
values are as follows:
host
none
task
public void setMemory(String memory)
The amount (in MiB) of memory used by the task.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory
value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines
your range of supported values for the Cpu
and Memory
parameters.
memory
- The amount (in MiB) of memory used by the task.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level
memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which
determines your range of supported values for the Cpu
and Memory
parameters.
public String getMemory()
The amount (in MiB) of memory used by the task.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory
value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines
your range of supported values for the Cpu
and Memory
parameters.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level
memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which
determines your range of supported values for the Cpu
and Memory
parameters.
public AwsEcsTaskDefinitionDetails withMemory(String memory)
The amount (in MiB) of memory used by the task.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory
value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines
your range of supported values for the Cpu
and Memory
parameters.
memory
- The amount (in MiB) of memory used by the task.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level
memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which
determines your range of supported values for the Cpu
and Memory
parameters.
public void setNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task. Valid values are as follows:
awsvpc
bridge
host
none
networkMode
- The Docker networking mode to use for the containers in the task. Valid values are as follows:
awsvpc
bridge
host
none
public String getNetworkMode()
The Docker networking mode to use for the containers in the task. Valid values are as follows:
awsvpc
bridge
host
none
awsvpc
bridge
host
none
public AwsEcsTaskDefinitionDetails withNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task. Valid values are as follows:
awsvpc
bridge
host
none
networkMode
- The Docker networking mode to use for the containers in the task. Valid values are as follows:
awsvpc
bridge
host
none
public void setPidMode(String pidMode)
The process namespace to use for the containers in the task. Valid values are host
or
task
.
pidMode
- The process namespace to use for the containers in the task. Valid values are host
or
task
.public String getPidMode()
The process namespace to use for the containers in the task. Valid values are host
or
task
.
host
or
task
.public AwsEcsTaskDefinitionDetails withPidMode(String pidMode)
The process namespace to use for the containers in the task. Valid values are host
or
task
.
pidMode
- The process namespace to use for the containers in the task. Valid values are host
or
task
.public List<AwsEcsTaskDefinitionPlacementConstraintsDetails> getPlacementConstraints()
The placement constraint objects to use for tasks.
public void setPlacementConstraints(Collection<AwsEcsTaskDefinitionPlacementConstraintsDetails> placementConstraints)
The placement constraint objects to use for tasks.
placementConstraints
- The placement constraint objects to use for tasks.public AwsEcsTaskDefinitionDetails withPlacementConstraints(AwsEcsTaskDefinitionPlacementConstraintsDetails... placementConstraints)
The 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.
placementConstraints
- The placement constraint objects to use for tasks.public AwsEcsTaskDefinitionDetails withPlacementConstraints(Collection<AwsEcsTaskDefinitionPlacementConstraintsDetails> placementConstraints)
The placement constraint objects to use for tasks.
placementConstraints
- The placement constraint objects to use for tasks.public void setProxyConfiguration(AwsEcsTaskDefinitionProxyConfigurationDetails proxyConfiguration)
The configuration details for the App Mesh proxy.
proxyConfiguration
- The configuration details for the App Mesh proxy.public AwsEcsTaskDefinitionProxyConfigurationDetails getProxyConfiguration()
The configuration details for the App Mesh proxy.
public AwsEcsTaskDefinitionDetails withProxyConfiguration(AwsEcsTaskDefinitionProxyConfigurationDetails proxyConfiguration)
The configuration details for the App Mesh proxy.
proxyConfiguration
- The configuration details for the App Mesh proxy.public List<String> getRequiresCompatibilities()
The task launch types that the task definition was validated against.
public void setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types that the task definition was validated against.
requiresCompatibilities
- The task launch types that the task definition was validated against.public AwsEcsTaskDefinitionDetails withRequiresCompatibilities(String... requiresCompatibilities)
The task launch types that the task definition was validated against.
NOTE: This method appends the values to the existing list (if any). Use
setRequiresCompatibilities(java.util.Collection)
or
withRequiresCompatibilities(java.util.Collection)
if you want to override the existing values.
requiresCompatibilities
- The task launch types that the task definition was validated against.public AwsEcsTaskDefinitionDetails withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types that the task definition was validated against.
requiresCompatibilities
- The task launch types that the task definition was validated against.public void setTaskRoleArn(String taskRoleArn)
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.
taskRoleArn
- The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web
Services API operations on your behalf.public String getTaskRoleArn()
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.
public AwsEcsTaskDefinitionDetails withTaskRoleArn(String taskRoleArn)
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.
taskRoleArn
- The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web
Services API operations on your behalf.public List<AwsEcsTaskDefinitionVolumesDetails> getVolumes()
The data volume definitions for the task.
public void setVolumes(Collection<AwsEcsTaskDefinitionVolumesDetails> volumes)
The data volume definitions for the task.
volumes
- The data volume definitions for the task.public AwsEcsTaskDefinitionDetails withVolumes(AwsEcsTaskDefinitionVolumesDetails... volumes)
The data volume definitions for the task.
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.
volumes
- The data volume definitions for the task.public AwsEcsTaskDefinitionDetails withVolumes(Collection<AwsEcsTaskDefinitionVolumesDetails> volumes)
The data volume definitions for the task.
volumes
- The data volume definitions for the task.public void setStatus(String status)
The status of the task definition.
status
- The status of the task definition.public String getStatus()
The status of the task definition.
public AwsEcsTaskDefinitionDetails withStatus(String status)
The status of the task definition.
status
- The status of the task definition.public String toString()
toString
in class Object
Object.toString()
public AwsEcsTaskDefinitionDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.