Class GpuDevice

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

The state of a GPU on a container instance, including its sharing mode and the memory that's available for new containers.

See Also:

  • Method Details

    • gpuId

      public final String gpuId()

      The ID of the GPU. This ID matches the GPU IDs in the gpuIds of the containers that Amazon ECS assigned to the GPU.

      Returns:
      The ID of the GPU. This ID matches the GPU IDs in the gpuIds of the containers that Amazon ECS assigned to the GPU.

    • sharingMode

      public final GpuSharingMode sharingMode()

      How the GPU is shared between containers.

      Valid values:

      • IDLE - No containers are assigned to the GPU, and all of its memory is available.

      • NVIDIA_MPS - One or more containers share the GPU by using NVIDIA Multi-Process Service (MPS).

      • DEDICATED - One container has exclusive use of the GPU.

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

      Returns:
      How the GPU is shared between containers.

      Valid values:

      • IDLE - No containers are assigned to the GPU, and all of its memory is available.

      • NVIDIA_MPS - One or more containers share the GPU by using NVIDIA Multi-Process Service (MPS).

      • DEDICATED - One container has exclusive use of the GPU.

      See Also:

    • sharingModeAsString

      public final String sharingModeAsString()

      How the GPU is shared between containers.

      Valid values:

      • IDLE - No containers are assigned to the GPU, and all of its memory is available.

      • NVIDIA_MPS - One or more containers share the GPU by using NVIDIA Multi-Process Service (MPS).

      • DEDICATED - One container has exclusive use of the GPU.

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

      Returns:
      How the GPU is shared between containers.

      Valid values:

      • IDLE - No containers are assigned to the GPU, and all of its memory is available.

      • NVIDIA_MPS - One or more containers share the GPU by using NVIDIA Multi-Process Service (MPS).

      • DEDICATED - One container has exclusive use of the GPU.

      See Also:

    • totalMemoryInMiB

      public final Integer totalMemoryInMiB()

      The total amount of GPU memory, in MiB, that the Amazon ECS container agent reported for the GPU. This is the memory that's available to containers, and it can be less than the nominal memory of the GPU.

      Returns:
      The total amount of GPU memory, in MiB, that the Amazon ECS container agent reported for the GPU. This is the memory that's available to containers, and it can be less than the nominal memory of the GPU.

    • remainingMemoryInMiB

      public final Integer remainingMemoryInMiB()

      The amount of GPU memory, in MiB, that's available to allocate to new containers that use the nvidiaMps sharing strategy. Amazon ECS calculates this value from the memory that it allocated to containers on the GPU, not from the memory that the containers use.

      Returns:
      The amount of GPU memory, in MiB, that's available to allocate to new containers that use the nvidiaMps sharing strategy. Amazon ECS calculates this value from the memory that it allocated to containers on the GPU, not from the memory that the containers use.

    • containerCount

      public final Integer containerCount()

      The number of containers that Amazon ECS assigned to the GPU. This value is 0 when the sharing mode is IDLE and 1 when the sharing mode is DEDICATED. Amazon ECS counts the containers that it assigned to the GPU, not the processes that are running on it.

      Returns:
      The number of containers that Amazon ECS assigned to the GPU. This value is 0 when the sharing mode is IDLE and 1 when the sharing mode is DEDICATED. Amazon ECS counts the containers that it assigned to the GPU, not the processes that are running on it.

    • toBuilder

      public GpuDevice.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GpuDevice.Builder,GpuDevice>
      Returns:
      a builder for type T

    • builder

      public static GpuDevice.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GpuDevice.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.