Class CapacityBlock

java.lang.Object
software.amazon.awssdk.services.ec2.model.CapacityBlock
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CapacityBlock.Builder,CapacityBlock>

@Generated("software.amazon.awssdk:codegen") public final class CapacityBlock extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CapacityBlock.Builder,CapacityBlock>

Reserve powerful GPU instances on a future date to support your short duration machine learning (ML) workloads. Instances that run inside a Capacity Block are automatically placed close together inside Amazon EC2 UltraClusters, for low-latency, petabit-scale, non-blocking networking.

You can also reserve Amazon EC2 UltraServers. UltraServers connect multiple EC2 instances using a low-latency, high-bandwidth accelerator interconnect (NeuronLink). They are built to tackle very large-scale AI/ML workloads that require significant processing power. For more information, see Amazon EC2 UltraServers.

See Also:
  • Method Details

    • capacityBlockId

      public final String capacityBlockId()

      The ID of the Capacity Block.

      Returns:
      The ID of the Capacity Block.
    • ultraserverType

      public final String ultraserverType()

      The EC2 UltraServer type of the Capacity Block.

      Returns:
      The EC2 UltraServer type of the Capacity Block.
    • availabilityZone

      public final String availabilityZone()

      The Availability Zone of the Capacity Block.

      Returns:
      The Availability Zone of the Capacity Block.
    • availabilityZoneId

      public final String availabilityZoneId()

      The Availability Zone ID of the Capacity Block.

      Returns:
      The Availability Zone ID of the Capacity Block.
    • hasCapacityReservationIds

      public final boolean hasCapacityReservationIds()
      For responses, this returns true if the service returned a value for the CapacityReservationIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • capacityReservationIds

      public final List<String> capacityReservationIds()

      The ID of the Capacity Reservation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapacityReservationIds() method.

      Returns:
      The ID of the Capacity Reservation.
    • startDate

      public final Instant startDate()

      The date and time at which the Capacity Block was started.

      Returns:
      The date and time at which the Capacity Block was started.
    • endDate

      public final Instant endDate()

      The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

      Returns:
      The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.
    • createDate

      public final Instant createDate()

      The date and time at which the Capacity Block was created.

      Returns:
      The date and time at which the Capacity Block was created.
    • state

      public final CapacityBlockResourceState state()

      The state of the Capacity Block.

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

      Returns:
      The state of the Capacity Block.
      See Also:
    • stateAsString

      public final String stateAsString()

      The state of the Capacity Block.

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

      Returns:
      The state of the Capacity Block.
      See Also:
    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • tags

      public final List<Tag> tags()

      The tags assigned to the Capacity Block.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags assigned to the Capacity Block.
    • toBuilder

      public CapacityBlock.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<CapacityBlock.Builder,CapacityBlock>
      Returns:
      a builder for type T
    • builder

      public static CapacityBlock.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CapacityBlock.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.