software.amazon.awssdk.services.ec2.model

Interface SpotInstanceRequest.Builder

All Superinterfaces:

CopyableBuilder<SpotInstanceRequest.Builder,SpotInstanceRequest>, SdkBuilder<SpotInstanceRequest.Builder,SpotInstanceRequest>

Enclosing class:

SpotInstanceRequest

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

Method Summary

Modifier and Type	Method and Description
SpotInstanceRequest.Builder	actualBlockHourlyPrice(String actualBlockHourlyPrice) If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.
SpotInstanceRequest.Builder	availabilityZoneGroup(String availabilityZoneGroup) The Availability Zone group.
SpotInstanceRequest.Builder	blockDurationMinutes(Integer blockDurationMinutes) The duration for the Spot instance, in minutes.
SpotInstanceRequest.Builder	createTime(Instant createTime) The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
default SpotInstanceRequest.Builder	fault(Consumer<SpotInstanceStateFault.Builder> fault) The fault codes for the Spot instance request, if any.
SpotInstanceRequest.Builder	fault(SpotInstanceStateFault fault) The fault codes for the Spot instance request, if any.
SpotInstanceRequest.Builder	instanceId(String instanceId) The instance ID, if an instance has been launched to fulfill the Spot instance request.
SpotInstanceRequest.Builder	instanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior) Indicates whether a Spot instance stops or terminates when it is interrupted.
SpotInstanceRequest.Builder	instanceInterruptionBehavior(String instanceInterruptionBehavior) Indicates whether a Spot instance stops or terminates when it is interrupted.
SpotInstanceRequest.Builder	launchedAvailabilityZone(String launchedAvailabilityZone) The Availability Zone in which the bid is launched.
SpotInstanceRequest.Builder	launchGroup(String launchGroup) The instance launch group.
default SpotInstanceRequest.Builder	launchSpecification(Consumer<LaunchSpecification.Builder> launchSpecification) Additional information for launching instances.
SpotInstanceRequest.Builder	launchSpecification(LaunchSpecification launchSpecification) Additional information for launching instances.
SpotInstanceRequest.Builder	productDescription(RIProductDescription productDescription) The product description associated with the Spot instance.
SpotInstanceRequest.Builder	productDescription(String productDescription) The product description associated with the Spot instance.
SpotInstanceRequest.Builder	spotInstanceRequestId(String spotInstanceRequestId) The ID of the Spot instance request.
SpotInstanceRequest.Builder	spotPrice(String spotPrice) The maximum hourly price (bid) for the Spot instance launched to fulfill the request.
SpotInstanceRequest.Builder	state(SpotInstanceState state) The state of the Spot instance request.
SpotInstanceRequest.Builder	state(String state) The state of the Spot instance request.
default SpotInstanceRequest.Builder	status(Consumer<SpotInstanceStatus.Builder> status) The status code and status message describing the Spot instance request.
SpotInstanceRequest.Builder	status(SpotInstanceStatus status) The status code and status message describing the Spot instance request.
SpotInstanceRequest.Builder	tags(Collection<Tag> tags) Any tags assigned to the resource.
SpotInstanceRequest.Builder	tags(Consumer<Tag.Builder>... tags) Any tags assigned to the resource.
SpotInstanceRequest.Builder	tags(Tag... tags) Any tags assigned to the resource.
SpotInstanceRequest.Builder	type(SpotInstanceType type) The Spot instance request type.
SpotInstanceRequest.Builder	type(String type) The Spot instance request type.
SpotInstanceRequest.Builder	validFrom(Instant validFrom) The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SpotInstanceRequest.Builder	validUntil(Instant validUntil) The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

copy

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

applyMutation, build

Method Detail

actualBlockHourlyPrice

SpotInstanceRequest.Builder actualBlockHourlyPrice(String actualBlockHourlyPrice)

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

Parameters:

actualBlockHourlyPrice - If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

Returns:

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

availabilityZoneGroup

SpotInstanceRequest.Builder availabilityZoneGroup(String availabilityZoneGroup)

The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

Parameters:

availabilityZoneGroup - The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

Returns:

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

blockDurationMinutes

SpotInstanceRequest.Builder blockDurationMinutes(Integer blockDurationMinutes)

The duration for the Spot instance, in minutes.

Parameters:

blockDurationMinutes - The duration for the Spot instance, in minutes.

Returns:

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

createTime

SpotInstanceRequest.Builder createTime(Instant createTime)

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Parameters:

createTime - The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Returns:

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

fault

SpotInstanceRequest.Builder fault(SpotInstanceStateFault fault)

The fault codes for the Spot instance request, if any.

Parameters:

fault - The fault codes for the Spot instance request, if any.

Returns:

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

fault

default SpotInstanceRequest.Builder fault(Consumer<SpotInstanceStateFault.Builder> fault)

The fault codes for the Spot instance request, if any.

This is a convenience that creates an instance of the SpotInstanceStateFault.Builder avoiding the need to create one manually via SpotInstanceStateFault.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fault(SpotInstanceStateFault).

Parameters:

fault - a consumer that will call methods on SpotInstanceStateFault.Builder

Returns:

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

See Also:

fault(SpotInstanceStateFault)

instanceId

SpotInstanceRequest.Builder instanceId(String instanceId)

The instance ID, if an instance has been launched to fulfill the Spot instance request.

Parameters:

instanceId - The instance ID, if an instance has been launched to fulfill the Spot instance request.

Returns:

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

launchGroup

SpotInstanceRequest.Builder launchGroup(String launchGroup)

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

Parameters:

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

Returns:

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

launchSpecification

SpotInstanceRequest.Builder launchSpecification(LaunchSpecification launchSpecification)

Additional information for launching instances.

Parameters:

launchSpecification - Additional information for launching instances.

Returns:

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

launchSpecification

default SpotInstanceRequest.Builder launchSpecification(Consumer<LaunchSpecification.Builder> launchSpecification)

Additional information for launching instances.

This is a convenience that creates an instance of the LaunchSpecification.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).

Parameters:

launchSpecification - a consumer that will call methods on LaunchSpecification.Builder

Returns:

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

See Also:

launchSpecification(LaunchSpecification)

launchedAvailabilityZone

SpotInstanceRequest.Builder launchedAvailabilityZone(String launchedAvailabilityZone)

The Availability Zone in which the bid is launched.

Parameters:

launchedAvailabilityZone - The Availability Zone in which the bid is launched.

Returns:

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

productDescription

SpotInstanceRequest.Builder productDescription(String productDescription)

The product description associated with the Spot instance.

Parameters:

productDescription - The product description associated with the Spot instance.

Returns:

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

See Also:

RIProductDescription, RIProductDescription

productDescription

SpotInstanceRequest.Builder productDescription(RIProductDescription productDescription)

The product description associated with the Spot instance.

Parameters:

productDescription - The product description associated with the Spot instance.

Returns:

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

See Also:

RIProductDescription, RIProductDescription

spotInstanceRequestId

SpotInstanceRequest.Builder spotInstanceRequestId(String spotInstanceRequestId)

The ID of the Spot instance request.

Parameters:

spotInstanceRequestId - The ID of the Spot instance request.

Returns:

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

spotPrice

SpotInstanceRequest.Builder spotPrice(String spotPrice)

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

Parameters:

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

Returns:

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

state

SpotInstanceRequest.Builder state(String state)

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

Parameters:

state - The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

Returns:

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

See Also:

SpotInstanceState, SpotInstanceState

state

SpotInstanceRequest.Builder state(SpotInstanceState state)

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

Parameters:

state - The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

Returns:

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

See Also:

SpotInstanceState, SpotInstanceState

status

SpotInstanceRequest.Builder status(SpotInstanceStatus status)

The status code and status message describing the Spot instance request.

Parameters:

status - The status code and status message describing the Spot instance request.

Returns:

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

status

default SpotInstanceRequest.Builder status(Consumer<SpotInstanceStatus.Builder> status)

The status code and status message describing the Spot instance request.

This is a convenience that creates an instance of the SpotInstanceStatus.Builder avoiding the need to create one manually via SpotInstanceStatus.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(SpotInstanceStatus).

Parameters:

status - a consumer that will call methods on SpotInstanceStatus.Builder

Returns:

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

See Also:

status(SpotInstanceStatus)

tags

SpotInstanceRequest.Builder tags(Collection<Tag> tags)

Any tags assigned to the resource.

Parameters:

tags - Any tags assigned to the resource.

Returns:

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

tags

SpotInstanceRequest.Builder tags(Tag... tags)

Any tags assigned to the resource.

Parameters:

tags - Any tags assigned to the resource.

Returns:

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

tags

SpotInstanceRequest.Builder tags(Consumer<Tag.Builder>... tags)

Any tags assigned to the resource.

This is a convenience that creates an instance of the 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 #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

type

SpotInstanceRequest.Builder type(String type)

The Spot instance request type.

Parameters:

type - The Spot instance request type.

Returns:

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

See Also:

SpotInstanceType, SpotInstanceType

type

SpotInstanceRequest.Builder type(SpotInstanceType type)

The Spot instance request type.

Parameters:

type - The Spot instance request type.

Returns:

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

See Also:

SpotInstanceType, SpotInstanceType

validFrom

SpotInstanceRequest.Builder validFrom(Instant validFrom)

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

Parameters:

validFrom - The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

Returns:

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

validUntil

SpotInstanceRequest.Builder validUntil(Instant validUntil)

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it 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 is reached.

Parameters:

validUntil - The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it 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 is reached.

Returns:

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

instanceInterruptionBehavior

SpotInstanceRequest.Builder instanceInterruptionBehavior(String instanceInterruptionBehavior)

Indicates whether a Spot instance stops or terminates when it is interrupted.

Parameters:

instanceInterruptionBehavior - Indicates whether a Spot instance stops or terminates when it is interrupted.

Returns:

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

See Also:

InstanceInterruptionBehavior, InstanceInterruptionBehavior

instanceInterruptionBehavior

SpotInstanceRequest.Builder instanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)

Indicates whether a Spot instance stops or terminates when it is interrupted.

Parameters:

instanceInterruptionBehavior - Indicates whether a Spot instance stops or terminates when it is interrupted.

Returns:

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

See Also:

InstanceInterruptionBehavior, InstanceInterruptionBehavior