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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCapacityManagerDimension.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccountId()The Amazon Web Services account ID that owns the capacity resource.StringavailabilityZoneId()The unique identifier of the Availability Zone where the capacity resource is located.static CapacityManagerDimension.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringinstanceFamily()The EC2 instance family of the capacity resource.StringinstancePlatform()The platform or operating system of the instance.StringinstanceType()The specific EC2 instance type of the capacity resource.StringreservationArn()The Amazon Resource Name (ARN) of the capacity reservation.InstantreservationCreateTimestamp()The timestamp when the capacity reservation was originally created, in milliseconds since epoch.ReservationEndDateTypereservationEndDateType()The type of end date for the capacity reservation.StringreservationEndDateTypeAsString()The type of end date for the capacity reservation.InstantreservationEndTimestamp()The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch.StringreservationId()The unique identifier of the capacity reservation.StringreservationInstanceMatchCriteria()The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.InstantreservationStartTimestamp()The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch.ReservationStatereservationState()The current state of the capacity reservation.StringreservationStateAsString()The current state of the capacity reservation.ReservationTypereservationType()The type of capacity reservation.StringreservationTypeAsString()The type of capacity reservation.StringreservationUnusedFinancialOwner()The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.StringresourceRegion()The Amazon Web Services Region where the capacity resource is located.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CapacityManagerDimension.Builder>serializableBuilderClass()CapacityTenancytenancy()The tenancy of the EC2 instances associated with this capacity dimension.StringtenancyAsString()The tenancy of the EC2 instances associated with this capacity dimension.CapacityManagerDimension.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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.
-
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,
reservationTypewill returnReservationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreservationTypeAsString().- Returns:
- The type of capacity reservation.
- See Also:
ReservationType
-
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,
reservationTypewill returnReservationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreservationTypeAsString().- Returns:
- The type of capacity reservation.
- See Also:
ReservationType
-
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,
reservationEndDateTypewill returnReservationEndDateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreservationEndDateTypeAsString().- 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,
reservationEndDateTypewill returnReservationEndDateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreservationEndDateTypeAsString().- 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,
tenancywill returnCapacityTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtenancyAsString().- 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,
tenancywill returnCapacityTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtenancyAsString().- 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
-
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,
reservationStatewill returnReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreservationStateAsString().- Returns:
- The current state of the capacity reservation.
- See Also:
ReservationState
-
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,
reservationStatewill returnReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreservationStateAsString().- 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.
-
toBuilder
public CapacityManagerDimension.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CapacityManagerDimension.Builder,CapacityManagerDimension>
-
builder
public static CapacityManagerDimension.Builder builder()
-
serializableBuilderClass
public static Class<? extends CapacityManagerDimension.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-