software.amazon.awssdk.services.ec2.model

Interface DescribeReservedInstancesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>, Ec2Request.Builder, SdkBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeReservedInstancesRequest

public static interface DescribeReservedInstancesRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeReservedInstancesRequest.Builder,DescribeReservedInstancesRequest>

Method Summary

Modifier and Type	Method and Description
DescribeReservedInstancesRequest.Builder	dryRun(Boolean dryRun) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
DescribeReservedInstancesRequest.Builder	filters(Collection<Filter> filters) One or more filters.
DescribeReservedInstancesRequest.Builder	filters(Consumer<Filter.Builder>... filters) One or more filters.
DescribeReservedInstancesRequest.Builder	filters(Filter... filters) One or more filters.
DescribeReservedInstancesRequest.Builder	offeringClass(OfferingClassType offeringClass) Describes whether the Reserved Instance is Standard or Convertible.
DescribeReservedInstancesRequest.Builder	offeringClass(String offeringClass) Describes whether the Reserved Instance is Standard or Convertible.
DescribeReservedInstancesRequest.Builder	offeringType(OfferingTypeValues offeringType) The Reserved Instance offering type.
DescribeReservedInstancesRequest.Builder	offeringType(String offeringType) The Reserved Instance offering type.
DescribeReservedInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeReservedInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeReservedInstancesRequest.Builder	reservedInstancesIds(Collection<String> reservedInstancesIds) One or more Reserved Instance IDs.
DescribeReservedInstancesRequest.Builder	reservedInstancesIds(String... reservedInstancesIds) One or more Reserved Instance IDs.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

filters

DescribeReservedInstancesRequest.Builder filters(Collection<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 ( 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeReservedInstancesRequest.Builder filters(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 ( 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeReservedInstancesRequest.Builder filters(Consumer<Filter.Builder>... 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).

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(java.util.Collection)

offeringClass

DescribeReservedInstancesRequest.Builder offeringClass(String offeringClass)

Describes whether the Reserved Instance is Standard or Convertible.

Parameters:

offeringClass - Describes whether the Reserved Instance is Standard or Convertible.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OfferingClassType, OfferingClassType

offeringClass

DescribeReservedInstancesRequest.Builder offeringClass(OfferingClassType offeringClass)

Describes whether the Reserved Instance is Standard or Convertible.

Parameters:

offeringClass - Describes whether the Reserved Instance is Standard or Convertible.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OfferingClassType, OfferingClassType

reservedInstancesIds

DescribeReservedInstancesRequest.Builder reservedInstancesIds(Collection<String> reservedInstancesIds)

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Parameters:

reservedInstancesIds - One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

reservedInstancesIds

DescribeReservedInstancesRequest.Builder reservedInstancesIds(String... reservedInstancesIds)

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Parameters:

reservedInstancesIds - One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

dryRun

DescribeReservedInstancesRequest.Builder dryRun(Boolean 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 is UnauthorizedOperation.

Parameters:

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 is UnauthorizedOperation.

Returns:

Returns a reference to this object so that method calls can be chained together.

offeringType

DescribeReservedInstancesRequest.Builder offeringType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

OfferingTypeValues, OfferingTypeValues

offeringType

DescribeReservedInstancesRequest.Builder offeringType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

OfferingTypeValues, OfferingTypeValues

overrideConfiguration

DescribeReservedInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeReservedInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder