Package software.amazon.awssdk.services.ec2.model

Class DescribeReservedInstancesOfferingsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ec2.model.DescribeReservedInstancesOfferingsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeReservedInstancesOfferingsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>

Contains the parameters for DescribeReservedInstancesOfferings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeReservedInstancesOfferingsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	availabilityZone()	The Availability Zone in which the Reserved Instance can be used.
static DescribeReservedInstancesOfferingsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters()	One or more filters.
int	hashCode()
Boolean	includeMarketplace()	Include Reserved Instance Marketplace offerings in the response.
String	instanceTenancy()	The tenancy of the instances covered by the reservation.
String	instanceType()	The instance type that the reservation will cover (for example, m1.small).
Long	maxDuration()	The maximum duration (in seconds) to filter when searching for offerings.
Integer	maxInstanceCount()	The maximum number of instances to filter when searching for offerings.
Integer	maxResults()	The maximum number of results to return for the request in a single page.
Long	minDuration()	The minimum duration (in seconds) to filter when searching for offerings.
String	nextToken()	The token to retrieve the next page of results.
String	offeringClass()	The offering class of the Reserved Instance.
String	offeringType()	The Reserved Instance offering type.
String	productDescription()	The Reserved Instance product platform description.
List<String>	reservedInstancesOfferingIds()	One or more Reserved Instances offering IDs.
static Class<? extends DescribeReservedInstancesOfferingsRequest.Builder>	serializableBuilderClass()
DescribeReservedInstancesOfferingsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.

filters

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 (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 to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

• 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-offering-id - The Reserved Instances offering ID.

• scope - The scope of the Reserved Instance (Availability Zone or Region).

• usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

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 to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

• 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-offering-id - The Reserved Instances offering ID.

• scope - The scope of the Reserved Instance (Availability Zone or Region).

• usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

includeMarketplace

public Boolean includeMarketplace()

Include Reserved Instance Marketplace offerings in the response.

Returns:

Include Reserved Instance Marketplace offerings in the response.

instanceType

public String instanceType()

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Returns:

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

See Also:

InstanceType

maxDuration

public Long 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

public Integer 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

public Long 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

public String offeringClass()

The offering class of the Reserved Instance. Can be standard or convertible.

Returns:

The offering class of the Reserved Instance. Can be standard or convertible.

See Also:

OfferingClassType

productDescription

public String productDescription()

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

Returns:

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

See Also:

RIProductDescription

reservedInstancesOfferingIds

public List<String> reservedInstancesOfferingIds()

One or more Reserved Instances offering IDs.

Returns:

One or more Reserved Instances offering IDs.

instanceTenancy

public String 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 the default or dedicated values only.

Default: default

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 the default or dedicated values only.

Default: default

See Also:

Tenancy

maxResults

public Integer 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

public String nextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

offeringType

public String 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.

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:

OfferingTypeValues

toBuilder

public DescribeReservedInstancesOfferingsRequest.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<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>

Returns:

a builder for type T

builder

public static DescribeReservedInstancesOfferingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeReservedInstancesOfferingsRequest.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