ReservedInstances (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.ec2.model.ReservedInstances

All Implemented Interfaces:: ToCopyableBuilder<ReservedInstances.Builder,ReservedInstances>

@Generated(value="software.amazon.awssdk:codegen")
public class ReservedInstances
extends Object
implements ToCopyableBuilder<ReservedInstances.Builder,ReservedInstances>

Describes a Reserved Instance.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReservedInstances.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReservedInstances.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZone()` The Availability Zone in which the Reserved Instance can be used.
`static ReservedInstances.Builder`	`builder()`
`CurrencyCodeValues`	`currencyCode()` The currency of the Reserved Instance.
`String`	`currencyCodeString()` The currency of the Reserved Instance.
`Long`	`duration()` The duration of the Reserved Instance, in seconds.
`Instant`	`end()` The time when the Reserved Instance expires.
`boolean`	`equals(Object obj)`
`Float`	`fixedPrice()` The purchase price of the Reserved Instance.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`instanceCount()` The number of reservations purchased.
`Tenancy`	`instanceTenancy()` The tenancy of the instance.
`String`	`instanceTenancyString()` The tenancy of the instance.
`InstanceType`	`instanceType()` The instance type on which the Reserved Instance can be used.
`String`	`instanceTypeString()` The instance type on which the Reserved Instance can be used.
`OfferingClassType`	`offeringClass()` The offering class of the Reserved Instance.
`String`	`offeringClassString()` The offering class of the Reserved Instance.
`OfferingTypeValues`	`offeringType()` The Reserved Instance offering type.
`String`	`offeringTypeString()` The Reserved Instance offering type.
`RIProductDescription`	`productDescription()` The Reserved Instance product platform description.
`String`	`productDescriptionString()` The Reserved Instance product platform description.
`List<RecurringCharge>`	`recurringCharges()` The recurring charge tag assigned to the resource.
`String`	`reservedInstancesId()` The ID of the Reserved Instance.
`Scope`	`scope()` The scope of the Reserved Instance.
`String`	`scopeString()` The scope of the Reserved Instance.
`static Class<? extends ReservedInstances.Builder>`	`serializableBuilderClass()`
`Instant`	`start()` The date and time the Reserved Instance started.
`ReservedInstanceState`	`state()` The state of the Reserved Instance purchase.
`String`	`stateString()` The state of the Reserved Instance purchase.
`List<Tag>`	`tags()` Any tags assigned to the resource.
`ReservedInstances.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Float`	`usagePrice()` The usage price of the Reserved Instance, per hour.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - availabilityZone
```
public String availabilityZone()
```
    The Availability Zone in which the Reserved Instance can be used.
    
    Returns:
    
    The Availability Zone in which the Reserved Instance can be used.
  - duration
```
public Long duration()
```
    The duration of the Reserved Instance, in seconds.
    
    Returns:
    
    The duration of the Reserved Instance, in seconds.
  - end
```
public Instant end()
```
    The time when the Reserved Instance expires.
    
    Returns:
    
    The time when the Reserved Instance expires.
  - fixedPrice
```
public Float fixedPrice()
```
    The purchase price of the Reserved Instance.
    
    Returns:
    
    The purchase price of the Reserved Instance.
  - instanceCount
```
public Integer instanceCount()
```
    The number of reservations purchased.
    
    Returns:
    
    The number of reservations purchased.
  - instanceType
```
public InstanceType instanceType()
```
    The instance type on which the Reserved Instance can be used.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeString().
    
    Returns:
    
    The instance type on which the Reserved Instance can be used.
    
    See Also:
    
    InstanceType
  - instanceTypeString
```
public String instanceTypeString()
```
    The instance type on which the Reserved Instance can be used.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeString().
    
    Returns:
    
    The instance type on which the Reserved Instance can be used.
    
    See Also:
    
    InstanceType
  - productDescription
```
public RIProductDescription productDescription()
```
    The Reserved Instance product platform description.
    
    If the service returns an enum value that is not available in the current SDK version, productDescription will return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionString().
    
    Returns:
    
    The Reserved Instance product platform description.
    
    See Also:
    
    RIProductDescription
  - productDescriptionString
```
public String productDescriptionString()
```
    The Reserved Instance product platform description.
    
    If the service returns an enum value that is not available in the current SDK version, productDescription will return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionString().
    
    Returns:
    
    The Reserved Instance product platform description.
    
    See Also:
    
    RIProductDescription
  - reservedInstancesId
```
public String reservedInstancesId()
```
    The ID of the Reserved Instance.
    
    Returns:
    
    The ID of the Reserved Instance.
  - start
```
public Instant start()
```
    The date and time the Reserved Instance started.
    
    Returns:
    
    The date and time the Reserved Instance started.
  - state
```
public ReservedInstanceState state()
```
    The state of the Reserved Instance purchase.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ReservedInstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateString().
    
    Returns:
    
    The state of the Reserved Instance purchase.
    
    See Also:
    
    ReservedInstanceState
  - stateString
```
public String stateString()
```
    The state of the Reserved Instance purchase.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ReservedInstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateString().
    
    Returns:
    
    The state of the Reserved Instance purchase.
    
    See Also:
    
    ReservedInstanceState
  - usagePrice
```
public Float usagePrice()
```
    The usage price of the Reserved Instance, per hour.
    
    Returns:
    
    The usage price of the Reserved Instance, per hour.
  - currencyCode
```
public CurrencyCodeValues currencyCode()
```
    The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
    
    If the service returns an enum value that is not available in the current SDK version, currencyCode will return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeString().
    
    Returns:
    
    The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
    
    See Also:
    
    CurrencyCodeValues
  - currencyCodeString
```
public String currencyCodeString()
```
    The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
    
    If the service returns an enum value that is not available in the current SDK version, currencyCode will return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeString().
    
    Returns:
    
    The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
    
    See Also:
    
    CurrencyCodeValues
  - instanceTenancy
```
public Tenancy instanceTenancy()
```
    The tenancy of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceTenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyString().
    
    Returns:
    
    The tenancy of the instance.
    
    See Also:
    
    Tenancy
  - instanceTenancyString
```
public String instanceTenancyString()
```
    The tenancy of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceTenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyString().
    
    Returns:
    
    The tenancy of the instance.
    
    See Also:
    
    Tenancy
  - offeringClass
```
public OfferingClassType offeringClass()
```
    The offering class of the Reserved Instance.
    
    If the service returns an enum value that is not available in the current SDK version, offeringClass will return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassString().
    
    Returns:
    
    The offering class of the Reserved Instance.
    
    See Also:
    
    OfferingClassType
  - offeringClassString
```
public String offeringClassString()
```
    The offering class of the Reserved Instance.
    
    If the service returns an enum value that is not available in the current SDK version, offeringClass will return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassString().
    
    Returns:
    
    The offering class of the Reserved Instance.
    
    See Also:
    
    OfferingClassType
  - offeringType
```
public OfferingTypeValues offeringType()
```
    The Reserved Instance offering type.
    
    If the service returns an enum value that is not available in the current SDK version, offeringType will return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeString().
    
    Returns:
    
    The Reserved Instance offering type.
    
    See Also:
    
    OfferingTypeValues
  - offeringTypeString
```
public String offeringTypeString()
```
    The Reserved Instance offering type.
    
    If the service returns an enum value that is not available in the current SDK version, offeringType will return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeString().
    
    Returns:
    
    The Reserved Instance offering type.
    
    See Also:
    
    OfferingTypeValues
  - recurringCharges
```
public List<RecurringCharge> recurringCharges()
```
    The recurring charge tag assigned to the resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The recurring charge tag assigned to the resource.
  - scope
```
public Scope scope()
```
    The scope of the Reserved Instance.
    
    If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeString().
    
    Returns:
    
    The scope of the Reserved Instance.
    
    See Also:
    
    Scope
  - scopeString
```
public String scopeString()
```
    The scope of the Reserved Instance.
    
    If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeString().
    
    Returns:
    
    The scope of the Reserved Instance.
    
    See Also:
    
    Scope
  - tags
```
public List<Tag> tags()
```
    Any tags assigned to the resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Any tags assigned to the resource.
  - toBuilder
```
public ReservedInstances.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<ReservedInstances.Builder,ReservedInstances>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ReservedInstances.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReservedInstances.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```

Class ReservedInstances

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

availabilityZone

duration

end

fixedPrice

instanceCount

instanceType

instanceTypeString

productDescription

productDescriptionString

reservedInstancesId

start

state

stateString

usagePrice

currencyCode

currencyCodeString

instanceTenancy

instanceTenancyString

offeringClass

offeringClassString

offeringType

offeringTypeString

recurringCharges

scope

scopeString

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField