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

Interface RequestSpotInstancesRequest.Builder

All Superinterfaces:

CopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>, SdkBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>

Enclosing class:

RequestSpotInstancesRequest

public static interface RequestSpotInstancesRequest.Builder
extends CopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>

Method Summary

Modifier and Type	Method	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	launchGroup(String launchGroup)	The instance launch group.
RequestSpotInstancesRequest.Builder	launchSpecification(LaunchSpecification launchSpecification)	The launch specification.
RequestSpotInstancesRequest.Builder	spotPrice(String 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.
RequestSpotInstancesRequest.Builder	type(SpotInstanceType type)	The Spot instance request type.
RequestSpotInstancesRequest.Builder	validFrom(Date validFrom)	The start date of the request.
RequestSpotInstancesRequest.Builder	validUntil(Date validUntil)	The end date of the request.

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

copy

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

apply, build

Method Detail

availabilityZoneGroup

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.

Parameters:

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.

Returns:

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

blockDurationMinutes

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.

Parameters:

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.

Returns:

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

clientToken

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.

Parameters:

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.

Returns:

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

instanceCount

RequestSpotInstancesRequest.Builder instanceCount(Integer instanceCount)

The maximum number of Spot instances to launch.

Default: 1

Parameters:

instanceCount - The maximum number of Spot instances to launch.

Default: 1

Returns:

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

launchGroup

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

Parameters:

launchGroup - The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Returns:

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

launchSpecification

RequestSpotInstancesRequest.Builder launchSpecification(LaunchSpecification launchSpecification)

The launch specification.

Parameters:

launchSpecification - The launch specification.

Returns:

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

spotPrice

RequestSpotInstancesRequest.Builder spotPrice(String spotPrice)

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

Parameters:

spotPrice - The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

Returns:

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

type

RequestSpotInstancesRequest.Builder type(String type)

The Spot instance request type.

Default: one-time

Parameters:

type - The Spot instance request type.

Default: one-time

Returns:

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

See Also:

SpotInstanceType

type

RequestSpotInstancesRequest.Builder type(SpotInstanceType type)

The Spot instance request type.

Default: one-time

Parameters:

type - The Spot instance request type.

Default: one-time

Returns:

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

See Also:

SpotInstanceType

validFrom

RequestSpotInstancesRequest.Builder validFrom(Date 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.

Parameters:

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.

Returns:

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

validUntil

RequestSpotInstancesRequest.Builder validUntil(Date 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.

Parameters:

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.

Returns:

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