public static interface RequestSpotInstancesRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>
| Modifier and Type | Method and Description |
|---|---|
RequestSpotInstancesRequest.Builder |
availabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of requests.
|
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)
The behavior when a Spot Instance is interrupted.
|
RequestSpotInstancesRequest.Builder |
instanceInterruptionBehavior(String instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.
|
RequestSpotInstancesRequest.Builder |
launchGroup(String launchGroup)
The instance launch group.
|
default RequestSpotInstancesRequest.Builder |
launchSpecification(Consumer<RequestSpotLaunchSpecification.Builder> launchSpecification)
The launch specification.
|
RequestSpotInstancesRequest.Builder |
launchSpecification(RequestSpotLaunchSpecification launchSpecification)
The launch specification.
|
RequestSpotInstancesRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RequestSpotInstancesRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
RequestSpotInstancesRequest.Builder |
spotPrice(String spotPrice)
The maximum price per hour that you are willing to pay for a Spot Instance.
|
RequestSpotInstancesRequest.Builder |
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The key-value pair for tagging the Spot Instance request on creation.
|
RequestSpotInstancesRequest.Builder |
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The key-value pair for tagging the Spot Instance request on creation.
|
RequestSpotInstancesRequest.Builder |
tagSpecifications(TagSpecification... tagSpecifications)
The key-value pair for tagging the Spot Instance request on creation.
|
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, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRequestSpotInstancesRequest.Builder availabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of requests.
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 requests 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 request is expired, or the maximum price you specified falls below current Spot price), 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 requests.
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 requests 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 request is expired, or the maximum price you specified falls below current Spot price), 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.
You can't specify an Availability Zone group or a launch group if you specify a duration.
New accounts or accounts with no previous billing history with AWS are not eligible for Spot Instances with a defined duration (also known as Spot blocks).
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.
You can't specify an Availability Zone group or a launch group if you specify a duration.
New accounts or accounts with no previous billing history with AWS are not eligible for Spot Instances with a defined duration (also known as Spot blocks).
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 EC2 User Guide for Linux Instances.
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 EC2 User Guide for Linux Instances.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(RequestSpotLaunchSpecification launchSpecification)
The launch specification.
launchSpecification - The launch specification.default RequestSpotInstancesRequest.Builder launchSpecification(Consumer<RequestSpotLaunchSpecification.Builder> launchSpecification)
The launch specification.
This is a convenience that creates an instance of theRequestSpotLaunchSpecification.Builder avoiding
the need to create one manually via RequestSpotLaunchSpecification.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to launchSpecification(RequestSpotLaunchSpecification).launchSpecification - a consumer that will call methods on RequestSpotLaunchSpecification.BuilderlaunchSpecification(RequestSpotLaunchSpecification)RequestSpotInstancesRequest.Builder spotPrice(String spotPrice)
The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
spotPrice - The maximum price per hour that you are willing to pay for a Spot Instance. The default is the
On-Demand price.RequestSpotInstancesRequest.Builder type(String type)
The Spot Instance request type.
Default: one-time
type - The Spot Instance request type.
Default: one-time
SpotInstanceType,
SpotInstanceTypeRequestSpotInstancesRequest.Builder type(SpotInstanceType type)
The Spot Instance request type.
Default: one-time
type - The Spot Instance request type.
Default: one-time
SpotInstanceType,
SpotInstanceTypeRequestSpotInstancesRequest.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.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
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.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
RequestSpotInstancesRequest.Builder validUntil(Instant validUntil)
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is
reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or
the ValidUntil date and time is reached. By default, the request is valid for 7 days from the
date the request was created.
validUntil - The end date of the request, in UTC format
(YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time
is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is
canceled, or the ValidUntil date and time is reached. By default, the request is valid
for 7 days from the date the request was created.
RequestSpotInstancesRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType
must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot
Instance request after it has been created, see CreateTags.
tagSpecifications - The key-value pair for tagging the Spot Instance request on creation. The value for
ResourceType must be spot-instances-request, otherwise the Spot Instance
request fails. To tag the Spot Instance request after it has been created, see CreateTags.RequestSpotInstancesRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType
must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot
Instance request after it has been created, see CreateTags.
tagSpecifications - The key-value pair for tagging the Spot Instance request on creation. The value for
ResourceType must be spot-instances-request, otherwise the Spot Instance
request fails. To tag the Spot Instance request after it has been created, see CreateTags.RequestSpotInstancesRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType
must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot
Instance request after it has been created, see CreateTags.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #tagSpecifications(List) .tagSpecifications - a consumer that will call methods on List.Builder #tagSpecifications(List) RequestSpotInstancesRequest.Builder instanceInterruptionBehavior(String instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted. The default is terminate.
instanceInterruptionBehavior - The behavior when a Spot Instance is interrupted. The default is terminate.InstanceInterruptionBehavior,
InstanceInterruptionBehaviorRequestSpotInstancesRequest.Builder instanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted. The default is terminate.
instanceInterruptionBehavior - The behavior when a Spot Instance is interrupted. The default is terminate.InstanceInterruptionBehavior,
InstanceInterruptionBehaviorRequestSpotInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRequestSpotInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.