Class CapacityManagerDimension

    • Method Detail

      • 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.
      • 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:
        ReservationEndDateType
      • 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:
        ReservationEndDateType
      • 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:
        CapacityTenancy
      • 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:
        CapacityTenancy
      • 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:
        ReservationState
      • 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.
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)