public static interface RequestSpotInstancesRequest.Builder extends Ec2Request.Builder, CopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>
Modifier and Type | Method and Description |
---|---|
RequestSpotInstancesRequest.Builder |
availabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
|
RequestSpotInstancesRequest.Builder |
blockDurationMinutes(Integer blockDurationMinutes)
The required duration for the Spot instances (also known as Spot blocks), in minutes.
|
RequestSpotInstancesRequest.Builder |
clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
RequestSpotInstancesRequest.Builder |
instanceCount(Integer instanceCount)
The maximum number of Spot instances to launch.
|
RequestSpotInstancesRequest.Builder |
instanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
RequestSpotInstancesRequest.Builder |
instanceInterruptionBehavior(String instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
RequestSpotInstancesRequest.Builder |
launchGroup(String launchGroup)
The instance launch group.
|
default RequestSpotInstancesRequest.Builder |
launchSpecification(Consumer<LaunchSpecification.Builder> launchSpecification)
The launch specification.
|
RequestSpotInstancesRequest.Builder |
launchSpecification(LaunchSpecification launchSpecification)
The launch specification.
|
RequestSpotInstancesRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
RequestSpotInstancesRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
RequestSpotInstancesRequest.Builder |
spotPrice(String spotPrice)
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
|
RequestSpotInstancesRequest.Builder |
type(SpotInstanceType type)
The Spot instance request type.
|
RequestSpotInstancesRequest.Builder |
type(String type)
The Spot instance request type.
|
RequestSpotInstancesRequest.Builder |
validFrom(Instant validFrom)
The start date of the request.
|
RequestSpotInstancesRequest.Builder |
validUntil(Instant validUntil)
The end date of the request.
|
build
overrideConfiguration
copy
applyMutation, build
RequestSpotInstancesRequest.Builder availabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
availabilityZoneGroup
- The user-specified name for a logical grouping of bids.
When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
RequestSpotInstancesRequest.Builder blockDurationMinutes(Integer blockDurationMinutes)
The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
blockDurationMinutes
- The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must
be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
RequestSpotInstancesRequest.Builder clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
information, see How to Ensure
Idempotency in the Amazon Elastic Compute Cloud User Guide.RequestSpotInstancesRequest.Builder instanceCount(Integer instanceCount)
The maximum number of Spot instances to launch.
Default: 1
instanceCount
- The maximum number of Spot instances to launch.
Default: 1
RequestSpotInstancesRequest.Builder launchGroup(String launchGroup)
The instance launch group. Launch groups are Spot instances that launch together and terminate together.
Default: Instances are launched and terminated individually
launchGroup
- The instance launch group. Launch groups are Spot instances that launch together and terminate
together.
Default: Instances are launched and terminated individually
RequestSpotInstancesRequest.Builder launchSpecification(LaunchSpecification launchSpecification)
The launch specification.
launchSpecification
- The launch specification.default RequestSpotInstancesRequest.Builder launchSpecification(Consumer<LaunchSpecification.Builder> launchSpecification)
The launch specification.
This is a convenience that creates an instance of theLaunchSpecification.Builder
avoiding the need
to create one manually via LaunchSpecification.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to launchSpecification(LaunchSpecification)
.launchSpecification
- a consumer that will call methods on LaunchSpecification.Builder
launchSpecification(LaunchSpecification)
RequestSpotInstancesRequest.Builder spotPrice(String spotPrice)
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
spotPrice
- The maximum hourly price (bid) for any Spot instance launched to fulfill the request.RequestSpotInstancesRequest.Builder type(String type)
The Spot instance request type.
Default: one-time
type
- The Spot instance request type.
Default: one-time
SpotInstanceType
,
SpotInstanceType
RequestSpotInstancesRequest.Builder type(SpotInstanceType type)
The Spot instance request type.
Default: one-time
type
- The Spot instance request type.
Default: one-time
SpotInstanceType
,
SpotInstanceType
RequestSpotInstancesRequest.Builder validFrom(Instant validFrom)
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
Default: The request is effective indefinitely.
validFrom
- The start date of the request. If this is a one-time request, the request becomes active at this date
and time and remains active until all instances launch, the request expires, or the request is
canceled. If the request is persistent, the request becomes active at this date and time and remains
active until it expires or is canceled.
Default: The request is effective indefinitely.
RequestSpotInstancesRequest.Builder validUntil(Instant validUntil)
The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
Default: The request is effective indefinitely.
validUntil
- The end date of the request. If this is a one-time request, the request remains active until all
instances launch, the request is canceled, or this date is reached. If the request is persistent, it
remains active until it is canceled or this date and time is reached.
Default: The request is effective indefinitely.
RequestSpotInstancesRequest.Builder instanceInterruptionBehavior(String instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
instanceInterruptionBehavior
- Indicates whether a Spot instance stops or terminates when it is interrupted.InstanceInterruptionBehavior
,
InstanceInterruptionBehavior
RequestSpotInstancesRequest.Builder instanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
instanceInterruptionBehavior
- Indicates whether a Spot instance stops or terminates when it is interrupted.InstanceInterruptionBehavior
,
InstanceInterruptionBehavior
RequestSpotInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.RequestSpotInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.