Class CapacityManagerDimension

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

Represents dimension values for capacity metrics, including resource identifiers, geographic information, and reservation details used for grouping and filtering capacity data.

See Also:

  • Method Details

    • resourceRegion

      public final String resourceRegion()

      The Amazon Web Services Region where the capacity resource is located.

      Returns:
      The Amazon Web Services Region where the capacity resource is located.

    • availabilityZoneId

      public final String availabilityZoneId()

      The unique identifier of the Availability Zone where the capacity resource is located.

      Returns:
      The unique identifier of the Availability Zone where the capacity resource is located.

    • accountId

      public final String accountId()

      The Amazon Web Services account ID that owns the capacity resource.

      Returns:
      The Amazon Web Services account ID that owns the capacity resource.

    • instanceFamily

      public final String instanceFamily()

      The EC2 instance family of the capacity resource.

      Returns:
      The EC2 instance family of the capacity resource.

    • instanceType

      public final String instanceType()

      The specific EC2 instance type of the capacity resource.

      Returns:
      The specific EC2 instance type of the capacity resource.

    • instancePlatform

      public final String instancePlatform()

      The platform or operating system of the instance.

      Returns:
      The platform or operating system of the instance.

    • reservationArn

      public final String reservationArn()

      The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.

      Returns:
      The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.

    • reservationId

      public final String reservationId()

      The unique identifier of the capacity reservation.

      Returns:
      The unique identifier of the capacity reservation.

    • reservationType

      public final ReservationType reservationType()

      The type of capacity reservation.

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

      Returns:
      The type of capacity reservation.
      See Also:

    • reservationTypeAsString

      public final String reservationTypeAsString()

      The type of capacity reservation.

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

      Returns:
      The type of capacity reservation.
      See Also:

    • reservationCreateTimestamp

      public final Instant reservationCreateTimestamp()

      The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.

      Returns:
      The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.

    • reservationStartTimestamp

      public final Instant reservationStartTimestamp()

      The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.

      Returns:
      The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.

    • reservationEndTimestamp

      public final Instant reservationEndTimestamp()

      The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.

      Returns:
      The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.

    • reservationEndDateType

      public final ReservationEndDateType reservationEndDateType()

      The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.

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

      Returns:
      The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
      See Also:

    • reservationEndDateTypeAsString

      public final String reservationEndDateTypeAsString()

      The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.

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

      Returns:
      The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
      See Also:

    • tenancy

      public final CapacityTenancy tenancy()

      The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.

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

      Returns:
      The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
      See Also:

    • tenancyAsString

      public final String tenancyAsString()

      The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.

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

      Returns:
      The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
      See Also:

    • reservationState

      public final ReservationState reservationState()

      The current state of the capacity reservation.

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

      Returns:
      The current state of the capacity reservation.
      See Also:

    • reservationStateAsString

      public final String reservationStateAsString()

      The current state of the capacity reservation.

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

      Returns:
      The current state of the capacity reservation.
      See Also:

    • reservationInstanceMatchCriteria

      public final String reservationInstanceMatchCriteria()

      The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.

      Returns:
      The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.

    • reservationUnusedFinancialOwner

      public final String reservationUnusedFinancialOwner()

      The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.

      Returns:
      The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.

    • toBuilder

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

    • builder

      public static CapacityManagerDimension.Builder builder()

    • serializableBuilderClass

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