software.amazon.awssdk.services.ec2.model

Interface CapacityReservationFleet.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CapacityReservationFleet.Builder,CapacityReservationFleet>, SdkBuilder<CapacityReservationFleet.Builder,CapacityReservationFleet>, SdkPojo

Enclosing class:

CapacityReservationFleet

public static interface CapacityReservationFleet.Builder
extends SdkPojo, CopyableBuilder<CapacityReservationFleet.Builder,CapacityReservationFleet>

Method Summary

Modifier and Type	Method and Description
CapacityReservationFleet.Builder	allocationStrategy(String allocationStrategy) The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.
CapacityReservationFleet.Builder	capacityReservationFleetArn(String capacityReservationFleetArn) The ARN of the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	capacityReservationFleetId(String capacityReservationFleetId) The ID of the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	createTime(Instant createTime) The date and time at which the Capacity Reservation Fleet was created.
CapacityReservationFleet.Builder	endDate(Instant endDate) The date and time at which the Capacity Reservation Fleet expires.
CapacityReservationFleet.Builder	instanceMatchCriteria(FleetInstanceMatchCriteria instanceMatchCriteria) Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
CapacityReservationFleet.Builder	instanceMatchCriteria(String instanceMatchCriteria) Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
CapacityReservationFleet.Builder	instanceTypeSpecifications(Collection<FleetCapacityReservation> instanceTypeSpecifications) Information about the instance types for which to reserve the capacity.
CapacityReservationFleet.Builder	instanceTypeSpecifications(Consumer<FleetCapacityReservation.Builder>... instanceTypeSpecifications) Information about the instance types for which to reserve the capacity.
CapacityReservationFleet.Builder	instanceTypeSpecifications(FleetCapacityReservation... instanceTypeSpecifications) Information about the instance types for which to reserve the capacity.
CapacityReservationFleet.Builder	state(CapacityReservationFleetState state) The state of the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	state(String state) The state of the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	tags(Collection<Tag> tags) The tags assigned to the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	tags(Consumer<Tag.Builder>... tags) The tags assigned to the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	tags(Tag... tags) The tags assigned to the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	tenancy(FleetCapacityReservationTenancy tenancy) The tenancy of the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	tenancy(String tenancy) The tenancy of the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	totalFulfilledCapacity(Double totalFulfilledCapacity) The capacity units that have been fulfilled.
CapacityReservationFleet.Builder	totalTargetCapacity(Integer totalTargetCapacity) The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

capacityReservationFleetId

CapacityReservationFleet.Builder capacityReservationFleetId(String capacityReservationFleetId)

The ID of the Capacity Reservation Fleet.

Parameters:

capacityReservationFleetId - The ID of the Capacity Reservation Fleet.

Returns:

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

capacityReservationFleetArn

CapacityReservationFleet.Builder capacityReservationFleetArn(String capacityReservationFleetArn)

The ARN of the Capacity Reservation Fleet.

Parameters:

capacityReservationFleetArn - The ARN of the Capacity Reservation Fleet.

Returns:

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

state

CapacityReservationFleet.Builder state(String state)

The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

Parameters:

state - The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

Returns:

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

See Also:

CapacityReservationFleetState, CapacityReservationFleetState

state

CapacityReservationFleet.Builder state(CapacityReservationFleetState state)

The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

Parameters:

state - The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

Returns:

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

See Also:

CapacityReservationFleetState, CapacityReservationFleetState

totalTargetCapacity

CapacityReservationFleet.Builder totalTargetCapacity(Integer totalTargetCapacity)

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the Amazon EC2 User Guide.

Parameters:

totalTargetCapacity - The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the Amazon EC2 User Guide.

Returns:

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

totalFulfilledCapacity

CapacityReservationFleet.Builder totalFulfilledCapacity(Double totalFulfilledCapacity)

The capacity units that have been fulfilled.

Parameters:

totalFulfilledCapacity - The capacity units that have been fulfilled.

Returns:

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

tenancy

CapacityReservationFleet.Builder tenancy(String tenancy)

The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

Parameters:

tenancy - The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

Returns:

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

See Also:

FleetCapacityReservationTenancy, FleetCapacityReservationTenancy

tenancy

CapacityReservationFleet.Builder tenancy(FleetCapacityReservationTenancy tenancy)

The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

Parameters:

tenancy - The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

Returns:

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

See Also:

FleetCapacityReservationTenancy, FleetCapacityReservationTenancy

endDate

CapacityReservationFleet.Builder endDate(Instant endDate)

The date and time at which the Capacity Reservation Fleet expires.

Parameters:

endDate - The date and time at which the Capacity Reservation Fleet expires.

Returns:

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

createTime

CapacityReservationFleet.Builder createTime(Instant createTime)

The date and time at which the Capacity Reservation Fleet was created.

Parameters:

createTime - The date and time at which the Capacity Reservation Fleet was created.

Returns:

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

instanceMatchCriteria

CapacityReservationFleet.Builder instanceMatchCriteria(String instanceMatchCriteria)

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

Parameters:

instanceMatchCriteria - Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

Returns:

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

See Also:

FleetInstanceMatchCriteria, FleetInstanceMatchCriteria

instanceMatchCriteria

CapacityReservationFleet.Builder instanceMatchCriteria(FleetInstanceMatchCriteria instanceMatchCriteria)

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

Parameters:

instanceMatchCriteria - Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

Returns:

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

See Also:

FleetInstanceMatchCriteria, FleetInstanceMatchCriteria

allocationStrategy

CapacityReservationFleet.Builder allocationStrategy(String allocationStrategy)

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see Allocation strategy in the Amazon EC2 User Guide.

Parameters:

allocationStrategy - The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see Allocation strategy in the Amazon EC2 User Guide.

Returns:

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

instanceTypeSpecifications

CapacityReservationFleet.Builder instanceTypeSpecifications(Collection<FleetCapacityReservation> instanceTypeSpecifications)

Information about the instance types for which to reserve the capacity.

Parameters:

instanceTypeSpecifications - Information about the instance types for which to reserve the capacity.

Returns:

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

instanceTypeSpecifications

CapacityReservationFleet.Builder instanceTypeSpecifications(FleetCapacityReservation... instanceTypeSpecifications)

Information about the instance types for which to reserve the capacity.

Parameters:

instanceTypeSpecifications - Information about the instance types for which to reserve the capacity.

Returns:

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

instanceTypeSpecifications

CapacityReservationFleet.Builder instanceTypeSpecifications(Consumer<FleetCapacityReservation.Builder>... instanceTypeSpecifications)

Information about the instance types for which to reserve the capacity.

This is a convenience method that creates an instance of the FleetCapacityReservation.Builder avoiding the need to create one manually via FleetCapacityReservation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceTypeSpecifications(List).

Parameters:

instanceTypeSpecifications - a consumer that will call methods on FleetCapacityReservation.Builder

Returns:

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

See Also:

#instanceTypeSpecifications(java.util.Collection)

tags

CapacityReservationFleet.Builder tags(Collection<Tag> tags)

The tags assigned to the Capacity Reservation Fleet.

Parameters:

tags - The tags assigned to the Capacity Reservation Fleet.

Returns:

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

tags

CapacityReservationFleet.Builder tags(Tag... tags)

The tags assigned to the Capacity Reservation Fleet.

Parameters:

tags - The tags assigned to the Capacity Reservation Fleet.

Returns:

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

tags

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

The tags assigned to the Capacity Reservation Fleet.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(java.util.Collection)