Class DescribeReservedInstancesOfferingsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,
DescribeReservedInstancesOfferingsRequest>
Contains the parameters for DescribeReservedInstancesOfferings.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone in which the Reserved Instance can be used.builder()
final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
One or more filters.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReservedInstancesOfferingIds property.final Boolean
Include Reserved Instance Marketplace offerings in the response.final Tenancy
The tenancy of the instances covered by the reservation.final String
The tenancy of the instances covered by the reservation.final InstanceType
The instance type that the reservation will cover (for example,m1.small
).final String
The instance type that the reservation will cover (for example,m1.small
).final Long
The maximum duration (in seconds) to filter when searching for offerings.final Integer
The maximum number of instances to filter when searching for offerings.final Integer
The maximum number of results to return for the request in a single page.final Long
The minimum duration (in seconds) to filter when searching for offerings.final String
The token to retrieve the next page of results.final OfferingClassType
The offering class of the Reserved Instance.final String
The offering class of the Reserved Instance.final OfferingTypeValues
The Reserved Instance offering type.final String
The Reserved Instance offering type.final RIProductDescription
The Reserved Instance product platform description.final String
The Reserved Instance product platform description.One or more Reserved Instances offering IDs.static Class
<? extends DescribeReservedInstancesOfferingsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
availabilityZone
The Availability Zone in which the Reserved Instance can be used.
- Returns:
- The Availability Zone in which the Reserved Instance can be used.
-
hasFilters
public final boolean hasFilters()For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
filters
One or more filters.
-
availability-zone
- The Availability Zone where the Reserved Instance can be used. -
duration
- The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000
|94608000
). -
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0). -
instance-type
- The instance type that is covered by the reservation. -
marketplace
- Set totrue
to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed. -
product-description
- The Reserved Instance product platform description (Linux/UNIX
|Linux with SQL Server Standard
|Linux with SQL Server Web
|Linux with SQL Server Enterprise
|SUSE Linux
|Red Hat Enterprise Linux
|Red Hat Enterprise Linux with HA
|Windows
|Windows with SQL Server Standard
|Windows with SQL Server Web
|Windows with SQL Server Enterprise
). -
reserved-instances-offering-id
- The Reserved Instances offering ID. -
scope
- The scope of the Reserved Instance (Availability Zone
orRegion
). -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- One or more filters.
-
availability-zone
- The Availability Zone where the Reserved Instance can be used. -
duration
- The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000
|94608000
). -
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0). -
instance-type
- The instance type that is covered by the reservation. -
marketplace
- Set totrue
to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed. -
product-description
- The Reserved Instance product platform description (Linux/UNIX
|Linux with SQL Server Standard
|Linux with SQL Server Web
|Linux with SQL Server Enterprise
|SUSE Linux
|Red Hat Enterprise Linux
|Red Hat Enterprise Linux with HA
|Windows
|Windows with SQL Server Standard
|Windows with SQL Server Web
|Windows with SQL Server Enterprise
). -
reserved-instances-offering-id
- The Reserved Instances offering ID. -
scope
- The scope of the Reserved Instance (Availability Zone
orRegion
). -
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
-
-
-
includeMarketplace
Include Reserved Instance Marketplace offerings in the response.
- Returns:
- Include Reserved Instance Marketplace offerings in the response.
-
instanceType
The instance type that the reservation will cover (for example,
m1.small
). For more information, see Instance types in the Amazon EC2 User Guide.If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type that the reservation will cover (for example,
m1.small
). For more information, see Instance types in the Amazon EC2 User Guide. - See Also:
-
instanceTypeAsString
The instance type that the reservation will cover (for example,
m1.small
). For more information, see Instance types in the Amazon EC2 User Guide.If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type that the reservation will cover (for example,
m1.small
). For more information, see Instance types in the Amazon EC2 User Guide. - See Also:
-
maxDuration
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
- Returns:
- The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
-
maxInstanceCount
The maximum number of instances to filter when searching for offerings.
Default: 20
- Returns:
- The maximum number of instances to filter when searching for offerings.
Default: 20
-
minDuration
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
- Returns:
- The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
-
offeringClass
The offering class of the Reserved Instance. Can be
standard
orconvertible
.If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- The offering class of the Reserved Instance. Can be
standard
orconvertible
. - See Also:
-
offeringClassAsString
The offering class of the Reserved Instance. Can be
standard
orconvertible
.If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- The offering class of the Reserved Instance. Can be
standard
orconvertible
. - See Also:
-
productDescription
The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the description are for use with Amazon VPC.If the service returns an enum value that is not available in the current SDK version,
productDescription
will returnRIProductDescription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductDescriptionAsString()
.- Returns:
- The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the description are for use with Amazon VPC. - See Also:
-
productDescriptionAsString
The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the description are for use with Amazon VPC.If the service returns an enum value that is not available in the current SDK version,
productDescription
will returnRIProductDescription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductDescriptionAsString()
.- Returns:
- The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the description are for use with Amazon VPC. - See Also:
-
hasReservedInstancesOfferingIds
public final boolean hasReservedInstancesOfferingIds()For responses, this returns true if the service returned a value for the ReservedInstancesOfferingIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
reservedInstancesOfferingIds
One or more Reserved Instances offering IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasReservedInstancesOfferingIds()
method.- Returns:
- One or more Reserved Instances offering IDs.
-
dryRun
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
instanceTenancy
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
dedicated
is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
dedicated
is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
- See Also:
-
instanceTenancyAsString
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
dedicated
is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
dedicated
is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
- See Also:
-
maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned
NextToken
value. The maximum is 100.Default: 100
- Returns:
- The maximum number of results to return for the request in a single page. The remaining results of the
initial request can be seen by sending another request with the returned
NextToken
value. The maximum is 100.Default: 100
-
nextToken
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
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 returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- 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. - See Also:
-
offeringTypeAsString
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 returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- 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. - See Also:
-
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 interfaceToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,
DescribeReservedInstancesOfferingsRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeReservedInstancesOfferingsRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-