@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ResourceRequirement extends Object implements Serializable, Cloneable, StructuredPojo
The type and amount of a resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
| Constructor and Description |
|---|
ResourceRequirement() |
| Modifier and Type | Method and Description |
|---|---|
ResourceRequirement |
clone() |
boolean |
equals(Object obj) |
String |
getType()
The type of resource to assign to a container.
|
String |
getValue()
The quantity of the specified resource to reserve for the container.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setType(String type)
The type of resource to assign to a container.
|
void |
setValue(String value)
The quantity of the specified resource to reserve for the container.
|
String |
toString()
Returns a string representation of this object.
|
ResourceRequirement |
withType(ResourceType type)
The type of resource to assign to a container.
|
ResourceRequirement |
withType(String type)
The type of resource to assign to a container.
|
ResourceRequirement |
withValue(String value)
The quantity of the specified resource to reserve for the container.
|
public void setValue(String value)
The quantity of the specified resource to reserve for the container. The values vary based on the
type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and the
--memory option to docker run. You must
specify at least 4 MiB of memory for a job. This is required but can be specified in several places for
multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and the
--memory option to docker run. You must
specify at least 4 MiB of memory for a job.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal
form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the
VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option
to docker run. Each vCPU is equivalent to 1,024 CPU
shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be
specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the
MEMORY values must be one of the values supported for that VCPU value. The supported values are
0.25, 0.5, 1, 2, and 4
MEMORY = 0.5, 1, or 2
MEMORY = 1, 2, 3, or 4
MEMORY = 2, 3, 4, 5, 6, 7, or 8
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
value - The quantity of the specified resource to reserve for the container. The values vary based on the
type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and
the --memory option to docker
run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in
several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This
parameter maps to Memory in the Create a container section of the
Docker Remote API and the --memory
option to docker run. You must specify at
least 4 MiB of memory for a job.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in
decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30,
inclusive) and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the
Docker Remote API and the
--cpu-shares option to docker
run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required
but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and
the MEMORY values must be one of the values supported for that VCPU value. The supported
values are 0.25, 0.5, 1, 2, and 4
MEMORY = 0.5, 1, or 2
MEMORY = 1, 2, 3, or 4
MEMORY = 2, 3, 4, 5, 6, 7, or 8
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28,
29, or 30
public String getValue()
The quantity of the specified resource to reserve for the container. The values vary based on the
type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and the
--memory option to docker run. You must
specify at least 4 MiB of memory for a job. This is required but can be specified in several places for
multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and the
--memory option to docker run. You must
specify at least 4 MiB of memory for a job.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal
form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the
VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option
to docker run. Each vCPU is equivalent to 1,024 CPU
shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be
specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the
MEMORY values must be one of the values supported for that VCPU value. The supported values are
0.25, 0.5, 1, 2, and 4
MEMORY = 0.5, 1, or 2
MEMORY = 1, 2, 3, or 4
MEMORY = 2, 3, 4, 5, 6, 7, or 8
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory in the Create
a container section of the Docker Remote API
and the --memory option to docker
run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in
several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This
parameter maps to Memory in the Create a container section of the
Docker Remote API and the --memory
option to docker run. You must specify at
least 4 MiB of memory for a job.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in
decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30,
inclusive) and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the
Docker Remote API and the
--cpu-shares option to docker
run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is
required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and
the MEMORY values must be one of the values supported for that VCPU value. The supported
values are 0.25, 0.5, 1, 2, and 4
MEMORY = 0.5, 1, or 2
MEMORY = 1, 2, 3, or 4
MEMORY = 2, 3, 4, 5, 6, 7, or 8
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28,
29, or 30
public ResourceRequirement withValue(String value)
The quantity of the specified resource to reserve for the container. The values vary based on the
type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and the
--memory option to docker run. You must
specify at least 4 MiB of memory for a job. This is required but can be specified in several places for
multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and the
--memory option to docker run. You must
specify at least 4 MiB of memory for a job.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal
form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the
VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option
to docker run. Each vCPU is equivalent to 1,024 CPU
shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be
specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the
MEMORY values must be one of the values supported for that VCPU value. The supported values are
0.25, 0.5, 1, 2, and 4
MEMORY = 0.5, 1, or 2
MEMORY = 1, 2, 3, or 4
MEMORY = 2, 3, 4, 5, 6, 7, or 8
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
value - The quantity of the specified resource to reserve for the container. The values vary based on the
type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and
the --memory option to docker
run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in
several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This
parameter maps to Memory in the Create a container section of the
Docker Remote API and the --memory
option to docker run. You must specify at
least 4 MiB of memory for a job.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in
decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30,
inclusive) and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the
Docker Remote API and the
--cpu-shares option to docker
run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required
but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and
the MEMORY values must be one of the values supported for that VCPU value. The supported
values are 0.25, 0.5, 1, 2, and 4
MEMORY = 0.5, 1, or 2
MEMORY = 1, 2, 3, or 4
MEMORY = 2, 3, 4, 5, 6, 7, or 8
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28,
29, or 30
public void setType(String type)
The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
type - The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.ResourceTypepublic String getType()
The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
GPU,
MEMORY, and VCPU.ResourceTypepublic ResourceRequirement withType(String type)
The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
type - The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.ResourceTypepublic ResourceRequirement withType(ResourceType type)
The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
type - The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.ResourceTypepublic String toString()
toString in class ObjectObject.toString()public ResourceRequirement clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.