@Generated(value="software.amazon.awssdk:codegen") public class DescribeReservedInstancesRequest extends EC2Request implements ToCopyableBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>
Contains the parameters for DescribeReservedInstances.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeReservedInstancesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeReservedInstancesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
List<Filter> |
filters()
One or more filters.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
OfferingClassType |
offeringClass()
Describes whether the Reserved Instance is Standard or Convertible.
|
String |
offeringClassString()
Describes whether the Reserved Instance is Standard or Convertible.
|
OfferingTypeValues |
offeringType()
The Reserved Instance offering type.
|
String |
offeringTypeString()
The Reserved Instance offering type.
|
List<String> |
reservedInstancesIds()
One or more Reserved Instance IDs.
|
static Class<? extends DescribeReservedInstancesRequest.Builder> |
serializableBuilderClass() |
DescribeReservedInstancesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public List<Filter> filters()
One or more filters.
availability-zone
- The Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (one year or three years), in seconds (
31536000
| 94608000
).
end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered by the reservation.
scope
- The scope of the Reserved Instance (Region
or Availability Zone
).
product-description
- The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the product platform description will only be displayed to EC2-Classic account
holders and are for use with Amazon VPC (Linux/UNIX
| Linux/UNIX (Amazon VPC)
|
SUSE Linux
| SUSE Linux (Amazon VPC)
| Red Hat Enterprise Linux
|
Red Hat Enterprise Linux (Amazon VPC)
| Windows
| Windows (Amazon VPC)
|
Windows with SQL Server Standard
| Windows with SQL Server Standard (Amazon VPC)
|
Windows with SQL Server Web
| Windows with SQL Server Web (Amazon VPC)
|
Windows with SQL Server Enterprise
| Windows with SQL Server Enterprise (Amazon VPC)
).
reserved-instances-id
- The ID of the Reserved Instance.
start
- The time at which the Reserved Instance purchase request was placed (for example,
2014-08-07T11:54:42.000Z).
state
- The state of the Reserved Instance (payment-pending
| active
|
payment-failed
| retired
).
tag
:key=value - The key/value combination of a tag assigned to the resource. Specify
the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag
Purpose=X, specify tag:Purpose
for the filter name and X
for the filter value.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
availability-zone
- The Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (one year or three years), in seconds (
31536000
| 94608000
).
end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered by the reservation.
scope
- The scope of the Reserved Instance (Region
or
Availability Zone
).
product-description
- The Reserved Instance product platform description. Instances that
include (Amazon VPC)
in the product platform description will only be displayed to
EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX
|
Linux/UNIX (Amazon VPC)
| SUSE Linux
| SUSE Linux (Amazon VPC)
|
Red Hat Enterprise Linux
| Red Hat Enterprise Linux (Amazon VPC)
|
Windows
| Windows (Amazon VPC)
| Windows with SQL Server Standard
| Windows with SQL Server Standard (Amazon VPC)
| Windows with SQL Server Web
|
Windows with SQL Server Web (Amazon VPC)
| Windows with SQL Server Enterprise
|
Windows with SQL Server Enterprise (Amazon VPC)
).
reserved-instances-id
- The ID of the Reserved Instance.
start
- The time at which the Reserved Instance purchase request was placed (for example,
2014-08-07T11:54:42.000Z).
state
- The state of the Reserved Instance (payment-pending
|
active
| payment-failed
| retired
).
tag
:key=value - The key/value combination of a tag assigned to the resource.
Specify the key of the tag in the filter name and the value of the tag in the filter value. For example,
for the tag Purpose=X, specify tag:Purpose
for the filter name and X
for the
filter value.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's
value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources
where Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
public OfferingClassType offeringClass()
Describes whether the Reserved Instance is Standard or Convertible.
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()
.
OfferingClassType
public String offeringClassString()
Describes whether the Reserved Instance is Standard or Convertible.
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()
.
OfferingClassType
public List<String> reservedInstancesIds()
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Default: Describes all your Reserved Instances, or only those otherwise specified.
public OfferingTypeValues offeringType()
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
have access to the Medium Utilization
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()
.
Medium Utilization
Reserved Instance offering type.OfferingTypeValues
public String offeringTypeString()
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
have access to the Medium Utilization
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()
.
Medium Utilization
Reserved Instance offering type.OfferingTypeValues
public DescribeReservedInstancesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>
toBuilder
in class EC2Request
public static DescribeReservedInstancesRequest.Builder builder()
public static Class<? extends DescribeReservedInstancesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.