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

Interface DescribeReservedInstancesOfferingsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>, Ec2Request.Builder, SdkBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeReservedInstancesOfferingsRequest
public static interface DescribeReservedInstancesOfferingsRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeReservedInstancesOfferingsRequest.Builder,DescribeReservedInstancesOfferingsRequest>

  • Method Details

    • availabilityZone

      DescribeReservedInstancesOfferingsRequest.Builder availabilityZone(String availabilityZone)

      The Availability Zone in which the Reserved Instance can be used.

      Parameters:
      availabilityZone - The Availability Zone in which the Reserved Instance can be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeReservedInstancesOfferingsRequest.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 (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 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 or Region).

      • 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 (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 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 or Region).

      • 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

      DescribeReservedInstancesOfferingsRequest.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 (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 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 or Region).

      • 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 (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 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 or Region).

      • 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

      DescribeReservedInstancesOfferingsRequest.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 (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 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 or Region).

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

      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:

    • includeMarketplace

      DescribeReservedInstancesOfferingsRequest.Builder includeMarketplace(Boolean includeMarketplace)

      Include Reserved Instance Marketplace offerings in the response.

      Parameters:
      includeMarketplace - Include Reserved Instance Marketplace offerings in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      DescribeReservedInstancesOfferingsRequest.Builder instanceType(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceType

      DescribeReservedInstancesOfferingsRequest.Builder instanceType(InstanceType 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxDuration

      DescribeReservedInstancesOfferingsRequest.Builder maxDuration(Long maxDuration)

      The maximum duration (in seconds) to filter when searching for offerings.

      Default: 94608000 (3 years)

      Parameters:
      maxDuration - The maximum duration (in seconds) to filter when searching for offerings.

      Default: 94608000 (3 years)

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

    • maxInstanceCount

      DescribeReservedInstancesOfferingsRequest.Builder maxInstanceCount(Integer maxInstanceCount)

      The maximum number of instances to filter when searching for offerings.

      Default: 20

      Parameters:
      maxInstanceCount - The maximum number of instances to filter when searching for offerings.

      Default: 20

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

    • minDuration

      DescribeReservedInstancesOfferingsRequest.Builder minDuration(Long minDuration)

      The minimum duration (in seconds) to filter when searching for offerings.

      Default: 2592000 (1 month)

      Parameters:
      minDuration - The minimum duration (in seconds) to filter when searching for offerings.

      Default: 2592000 (1 month)

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

    • offeringClass

      DescribeReservedInstancesOfferingsRequest.Builder offeringClass(String offeringClass)

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

      Parameters:
      offeringClass - The offering class of the Reserved Instance. Can be standard or convertible.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • offeringClass

      DescribeReservedInstancesOfferingsRequest.Builder offeringClass(OfferingClassType offeringClass)

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

      Parameters:
      offeringClass - The offering class of the Reserved Instance. Can be standard or convertible.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • productDescription

      DescribeReservedInstancesOfferingsRequest.Builder productDescription(String productDescription)

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

      Parameters:
      productDescription - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • productDescription

      DescribeReservedInstancesOfferingsRequest.Builder productDescription(RIProductDescription productDescription)

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

      Parameters:
      productDescription - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • reservedInstancesOfferingIds

      DescribeReservedInstancesOfferingsRequest.Builder reservedInstancesOfferingIds(Collection<String> reservedInstancesOfferingIds)

      One or more Reserved Instances offering IDs.

      Parameters:
      reservedInstancesOfferingIds - One or more Reserved Instances offering IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservedInstancesOfferingIds

      DescribeReservedInstancesOfferingsRequest.Builder reservedInstancesOfferingIds(String... reservedInstancesOfferingIds)

      One or more Reserved Instances offering IDs.

      Parameters:
      reservedInstancesOfferingIds - One or more Reserved Instances offering IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

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

    • instanceTenancy

      DescribeReservedInstancesOfferingsRequest.Builder instanceTenancy(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceTenancy

      DescribeReservedInstancesOfferingsRequest.Builder instanceTenancy(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      DescribeReservedInstancesOfferingsRequest.Builder maxResults(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeReservedInstancesOfferingsRequest.Builder nextToken(String nextToken)

      The token to retrieve the next page of results.

      Parameters:
      nextToken - The token to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • offeringType

      DescribeReservedInstancesOfferingsRequest.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:

    • offeringType

      DescribeReservedInstancesOfferingsRequest.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:

    • overrideConfiguration

      DescribeReservedInstancesOfferingsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeReservedInstancesOfferingsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.