software.amazon.awssdk.services.ec2.model

Class DescribeReservedInstancesOfferingsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>

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

Contains the parameters for DescribeReservedInstancesOfferings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeReservedInstancesOfferingsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZone() The Availability Zone in which the Reserved Instance can be used.
static DescribeReservedInstancesOfferingsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeMarketplace() Include Reserved Instance Marketplace offerings in the response.
Tenancy	instanceTenancy() The tenancy of the instances covered by the reservation.
String	instanceTenancyAsString() The tenancy of the instances covered by the reservation.
InstanceType	instanceType() The instance type that the reservation will cover (for example, m1.small).
String	instanceTypeAsString() 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.
OfferingClassType	offeringClass() The offering class of the Reserved Instance.
String	offeringClassAsString() The offering class of the Reserved Instance.
OfferingTypeValues	offeringType() The Reserved Instance offering type.
String	offeringTypeAsString() The Reserved Instance offering type.
RIProductDescription	productDescription() The Reserved Instance product platform description.
String	productDescriptionAsString() The Reserved Instance product platform description.
List<String>	reservedInstancesOfferingIds() One or more Reserved Instances offering IDs.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeReservedInstancesOfferingsRequest.Builder>	serializableBuilderClass()
DescribeReservedInstancesOfferingsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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 InstanceType 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.

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 instanceTypeAsString().

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

instanceTypeAsString

public String instanceTypeAsString()

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.

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 instanceTypeAsString().

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 OfferingClassType offeringClass()

The offering class of the Reserved Instance. Can be 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 offeringClassAsString().

Returns:

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

See Also:

OfferingClassType

offeringClassAsString

public String offeringClassAsString()

The offering class of the Reserved Instance. Can be 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 offeringClassAsString().

Returns:

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

See Also:

OfferingClassType

productDescription

public RIProductDescription 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 return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

Returns:

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

See Also:

RIProductDescription

productDescriptionAsString

public String 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 return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more Reserved Instances offering IDs.

instanceTenancy

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

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 instanceTenancyAsString().

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

instanceTenancyAsString

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

Default: default

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 instanceTenancyAsString().

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 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 offeringTypeAsString().

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

offeringTypeAsString

public String 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 return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeReservedInstancesOfferingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeReservedInstancesOfferingsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo