Interface PurchaseHostReservationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<PurchaseHostReservationRequest.Builder,
,PurchaseHostReservationRequest> Ec2Request.Builder
,SdkBuilder<PurchaseHostReservationRequest.Builder,
,PurchaseHostReservationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PurchaseHostReservationRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.currencyCode
(String currencyCode) The currency in which thetotalUpfrontPrice
,LimitPrice
, andtotalHourlyPrice
amounts are specified.currencyCode
(CurrencyCodeValues currencyCode) The currency in which thetotalUpfrontPrice
,LimitPrice
, andtotalHourlyPrice
amounts are specified.The IDs of the Dedicated Hosts with which the reservation will be associated.hostIdSet
(Collection<String> hostIdSet) The IDs of the Dedicated Hosts with which the reservation will be associated.limitPrice
(String limitPrice) The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count).offeringId
(String offeringId) The ID of the offering.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tagSpecifications
(Collection<TagSpecification> tagSpecifications) The tags to apply to the Dedicated Host Reservation during purchase.tagSpecifications
(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the Dedicated Host Reservation during purchase.tagSpecifications
(TagSpecification... tagSpecifications) The tags to apply to the Dedicated Host Reservation during purchase.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
- Parameters:
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
currencyCode
The currency in which the
totalUpfrontPrice
,LimitPrice
, andtotalHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
.- Parameters:
currencyCode
- The currency in which thetotalUpfrontPrice
,LimitPrice
, andtotalHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
currencyCode
The currency in which the
totalUpfrontPrice
,LimitPrice
, andtotalHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
.- Parameters:
currencyCode
- The currency in which thetotalUpfrontPrice
,LimitPrice
, andtotalHourlyPrice
amounts are specified. At this time, the only supported currency isUSD
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hostIdSet
The IDs of the Dedicated Hosts with which the reservation will be associated.
- Parameters:
hostIdSet
- The IDs of the Dedicated Hosts with which the reservation will be associated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hostIdSet
The IDs of the Dedicated Hosts with which the reservation will be associated.
- Parameters:
hostIdSet
- The IDs of the Dedicated Hosts with which the reservation will be associated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limitPrice
The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is
USD
. For example, to indicate a limit price of USD 100, specify 100.00.- Parameters:
limitPrice
- The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency isUSD
. For example, to indicate a limit price of USD 100, specify 100.00.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
offeringId
The ID of the offering.
- Parameters:
offeringId
- The ID of the offering.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
PurchaseHostReservationRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the Dedicated Host Reservation during purchase.
- Parameters:
tagSpecifications
- The tags to apply to the Dedicated Host Reservation during purchase.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
The tags to apply to the Dedicated Host Reservation during purchase.
- Parameters:
tagSpecifications
- The tags to apply to the Dedicated Host Reservation during purchase.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
PurchaseHostReservationRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the Dedicated Host Reservation during purchase.
This is a convenience method that creates an instance of theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagSpecifications(List<TagSpecification>)
.- Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
PurchaseHostReservationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PurchaseHostReservationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-