Package software.amazon.awssdk.services.ecs.model

Class ResourceRequirement

java.lang.Object
software.amazon.awssdk.services.ecs.model.ResourceRequirement
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ResourceRequirement.Builder,ResourceRequirement>
@Generated("software.amazon.awssdk:codegen") public final class ResourceRequirement extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ResourceRequirement.Builder,ResourceRequirement>

The type and amount of a resource to assign to a container. The supported resource types are GPUs, Neuron devices, and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

See Also:

  • Method Details

    • value

      public final String value()

      The value for the specified resource type.

      When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. You can also specify ALL to allocate all available GPUs on the instance to the container.

      When the type is NeuronDevice, the value must be ALL. This allocates all available Neuron devices on the instance to the container. Only one container in a task can specify NeuronDevice resources. This resource type is only supported on Managed Instances.

      When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

      Returns:
      The value for the specified resource type.

      When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. You can also specify ALL to allocate all available GPUs on the instance to the container.

      When the type is NeuronDevice, the value must be ALL. This allocates all available Neuron devices on the instance to the container. Only one container in a task can specify NeuronDevice resources. This resource type is only supported on Managed Instances.

      When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

    • type

      public final ResourceType type()

      The type of resource to assign to a container.

      If the service returns an enum value that is not available in the current SDK version, type will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of resource to assign to a container.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of resource to assign to a container.

      If the service returns an enum value that is not available in the current SDK version, type will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of resource to assign to a container.
      See Also:

    • toBuilder

      public ResourceRequirement.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ResourceRequirement.Builder,ResourceRequirement>

    • builder

      public static ResourceRequirement.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ResourceRequirement.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo