/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.DescribeReservedInstancesRequestMarshaller; /** *
* Contains the parameters for DescribeReservedInstances. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest* 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 (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-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>
- The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* Describes whether the Reserved Instance is Standard or Convertible. *
*/ private String offeringClass; /** ** One or more Reserved Instance IDs. *
** Default: Describes all your Reserved Instances, or only those otherwise specified. *
*/ private com.amazonaws.internal.SdkInternalList
* 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.
*
* 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 (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-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>
- The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* 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 (
* 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-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>
- The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner
and the value TeamA
, specify
* tag:Owner
for the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* 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 (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-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>
- The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* 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 (
* 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-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>
- The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner
and the value TeamA
, specify tag:Owner
for
* the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* 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 (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-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>
- The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. *
* * @param 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 (
* 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-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>
- The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner
and the value TeamA
, specify tag:Owner
for
* the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* 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 (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-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>
- The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* 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 (
* 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-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>
- The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner
and the value TeamA
, specify tag:Owner
for
* the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
*
* Describes whether the Reserved Instance is Standard or Convertible. *
* * @param offeringClass * Describes whether the Reserved Instance is Standard or Convertible. * @see OfferingClassType */ public void setOfferingClass(String offeringClass) { this.offeringClass = offeringClass; } /** ** Describes whether the Reserved Instance is Standard or Convertible. *
* * @return Describes whether the Reserved Instance is Standard or Convertible. * @see OfferingClassType */ public String getOfferingClass() { return this.offeringClass; } /** ** Describes whether the Reserved Instance is Standard or Convertible. *
* * @param offeringClass * Describes whether the Reserved Instance is Standard or Convertible. * @return Returns a reference to this object so that method calls can be chained together. * @see OfferingClassType */ public DescribeReservedInstancesRequest withOfferingClass(String offeringClass) { setOfferingClass(offeringClass); return this; } /** ** Describes whether the Reserved Instance is Standard or Convertible. *
* * @param offeringClass * Describes whether the Reserved Instance is Standard or Convertible. * @see OfferingClassType */ public void setOfferingClass(OfferingClassType offeringClass) { withOfferingClass(offeringClass); } /** ** Describes whether the Reserved Instance is Standard or Convertible. *
* * @param offeringClass * Describes whether the Reserved Instance is Standard or Convertible. * @return Returns a reference to this object so that method calls can be chained together. * @see OfferingClassType */ public DescribeReservedInstancesRequest withOfferingClass(OfferingClassType offeringClass) { this.offeringClass = offeringClass.toString(); return this; } /** ** One or more Reserved Instance IDs. *
** Default: Describes all your Reserved Instances, or only those otherwise specified. *
* * @return One or more Reserved Instance IDs. *
* Default: Describes all your Reserved Instances, or only those otherwise specified.
*/
public java.util.List
* One or more Reserved Instance IDs.
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
*/
public void setReservedInstancesIds(java.util.Collection
* One or more Reserved Instance IDs.
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setReservedInstancesIds(java.util.Collection)} or {@link #withReservedInstancesIds(java.util.Collection)}
* if you want to override the existing values.
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesRequest withReservedInstancesIds(String... reservedInstancesIds) {
if (this.reservedInstancesIds == null) {
setReservedInstancesIds(new com.amazonaws.internal.SdkInternalList
* One or more Reserved Instance IDs.
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
*
* Default: Describes all your Reserved Instances, or only those otherwise specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedInstancesRequest withReservedInstancesIds(java.util.Collection
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the
* The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
* have access to the
* 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.
* Medium Utilization
Reserved Instance offering type.
* @see OfferingTypeValues
*/
public void setOfferingType(String offeringType) {
this.offeringType = offeringType;
}
/**
* Medium Utilization
Reserved Instance offering type.
* Medium Utilization
Reserved Instance offering type.
* @see OfferingTypeValues
*/
public String getOfferingType() {
return this.offeringType;
}
/**
* Medium Utilization
Reserved Instance offering type.
* Medium Utilization
Reserved Instance offering type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingTypeValues
*/
public DescribeReservedInstancesRequest withOfferingType(String offeringType) {
setOfferingType(offeringType);
return this;
}
/**
* Medium Utilization
Reserved Instance offering type.
* Medium Utilization
Reserved Instance offering type.
* @see OfferingTypeValues
*/
public void setOfferingType(OfferingTypeValues offeringType) {
withOfferingType(offeringType);
}
/**
* Medium Utilization
Reserved Instance offering type.
* Medium Utilization
Reserved Instance offering type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OfferingTypeValues
*/
public DescribeReservedInstancesRequest withOfferingType(OfferingTypeValues offeringType) {
this.offeringType = offeringType.toString();
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request